diff --git a/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/AbstractJacksonSerializationTest.java b/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/AbstractJacksonSerializationTest.java index f2dc1015..7094f029 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/AbstractJacksonSerializationTest.java +++ b/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/AbstractJacksonSerializationTest.java @@ -195,6 +195,24 @@ void legacyInvalidParamProblem() throws IOException { assertThat(writeProblem(badRequestProblem)).isEqualToIgnoringWhitespace(json); } + @Test + void titleAndStatusOverride() throws IOException { + String json = "{\n" + + " \"type\": \"urn:problem-type:belgif:badRequest\",\n" + + " \"href\": \"https://www.test.be\",\n" + + " \"title\": \"TEST\",\n" + + " \"status\": 401,\n" + + " \"detail\": \"Test\"\n" + + "}"; + Problem problem = readProblem(json); + assertThat(problem).isInstanceOf(BadRequestProblem.class); + BadRequestProblem badRequestProblem = (BadRequestProblem) problem; + assertThat(badRequestProblem.getType()).isEqualTo(BadRequestProblem.TYPE_URI); + assertThat(badRequestProblem.getHref()).isEqualTo(URI.create("https://www.test.be")); + assertThat(badRequestProblem.getStatus()).isEqualTo(BadRequestProblem.STATUS); + assertThat(badRequestProblem.getTitle()).isEqualTo(BadRequestProblem.TITLE); + } + @Test void unknownProblemWithMessage() throws IOException { String json = "{\n" diff --git a/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/AbstractRestProblemIT.java b/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/AbstractRestProblemIT.java index ff2d22a3..fc75ae53 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/AbstractRestProblemIT.java +++ b/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/AbstractRestProblemIT.java @@ -133,6 +133,18 @@ public void jacksonMismatchedInputFromBackend(String client) { .body("type", equalTo("urn:problem-type:belgif:internalServerError")); } + @ParameterizedTest + @MethodSource("getClients") + public void inconsistentProblemStatusFromBackend(String client) { + getSpec().when().queryParam("client", client) + .get("/inconsistentProblemStatusFromBackend").then().assertThat() + .statusCode(400) + .body("type", equalTo("urn:problem-type:belgif:badRequest")) + .body("detail", equalTo("Bad Request with inconsistent problem status code" + + " (caught successfully by frontend)")) + .body("status", equalTo(400)); + } + @Test public void notFound() { getSpec().when().get("/not/found").then().assertThat() @@ -562,4 +574,13 @@ public void invalidJsonType() { .body("issues[0].value", equalTo("twenty-two")); } + @ParameterizedTest + @MethodSource("getClients") + public void healthDown(String client) { + getSpec().when().queryParam("client", client) + .get("/healthDown").then().assertThat() + .statusCode(503) + .body("status", equalTo("DOWN")); + } + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/ProblemPayloads.java b/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/ProblemPayloads.java new file mode 100644 index 00000000..8b32f718 --- /dev/null +++ b/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/it/ProblemPayloads.java @@ -0,0 +1,19 @@ +package io.github.belgif.rest.problem.it; + +/** + * Problem payload constants. + */ +public class ProblemPayloads { + + public static final String INCONSISTENT_STATUS_CODE = "{\n" + + " \"type\": \"urn:problem-type:belgif:badRequest\",\n" + + " \"href\": \"https://www.belgif.be/specification/rest/api-guide/problems/badRequest.html\",\n" + + " \"title\": \"Bad Request\",\n" + + " \"status\": 401,\n" // <- 401 instead of 400 + + " \"detail\": \"Bad Request with inconsistent problem status code\"\n" + + "}"; + + private ProblemPayloads() { + } + +} diff --git a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/pom.xml b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/pom.xml index 95b603f4..5437975d 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/pom.xml +++ b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/pom.xml @@ -62,6 +62,12 @@ provided 3.0.1.Final + + org.slf4j + slf4j-api + 2.0.19 + provided + org.junit.jupiter junit-jupiter diff --git a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/Backend.java b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/Backend.java index 2694124f..d158a912 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/Backend.java +++ b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/Backend.java @@ -31,4 +31,12 @@ public interface Backend { @Path("/jacksonMismatchedInput") Response jacksonMismatchedInput(); + @GET + @Path("/inconsistentProblemStatus") + Response inconsistentProblemStatus(); + + @GET + @Path("/healthDown") + Response healthDown(); + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/BackendImpl.java b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/BackendImpl.java index 8da77b71..4819a9ec 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/BackendImpl.java +++ b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/BackendImpl.java @@ -1,6 +1,8 @@ package io.github.belgif.rest.problem; import java.net.URI; +import java.util.HashMap; +import java.util.Map; import jakarta.enterprise.context.RequestScoped; import jakarta.ws.rs.core.MediaType; @@ -9,6 +11,7 @@ import com.acme.custom.CustomProblem; import io.github.belgif.rest.problem.api.Problem; +import io.github.belgif.rest.problem.it.ProblemPayloads; import io.github.belgif.rest.problem.it.model.JacksonModel; @RequestScoped @@ -56,4 +59,22 @@ public Response jacksonMismatchedInput() { return Response.ok(model, MediaType.APPLICATION_JSON_TYPE).build(); } + @Override + public Response inconsistentProblemStatus() { + return Response.status(402) // -> HTTP status code 402 instead of 400 + .type("application/problem+json") + .entity(ProblemPayloads.INCONSISTENT_STATUS_CODE) // -> problem status code 401 instead of 400 + .build(); + } + + @Override + public Response healthDown() { + Map response = new HashMap<>(); + response.put("status", "DOWN"); + return Response.status(Response.Status.SERVICE_UNAVAILABLE) + .type(MediaType.APPLICATION_JSON_TYPE) + .entity(response) + .build(); + } + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/Frontend.java b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/Frontend.java index 1b0cba04..1341ece7 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/Frontend.java +++ b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/Frontend.java @@ -73,6 +73,10 @@ public interface Frontend { @Path("/jacksonMismatchedInputFromBackend") Response jacksonMismatchedInputFromBackend(@QueryParam("client") Client client); + @GET + @Path("/inconsistentProblemStatusFromBackend") + Response inconsistentProblemStatusFromBackend(@QueryParam("client") Client client); + @GET @Path("/beanValidation/queryParameter") Response beanValidationQueryParameter(@QueryParam("param") @NotNull @Positive Integer p, @@ -118,4 +122,8 @@ Response beanValidationQueryParameter(@QueryParam("param") @NotNull @Positive In @Path("/jackson/mismatchedInputException") Response jacksonMismatchedInputException(@Valid JacksonModel body); + @GET + @Path("/healthDown") + Response healthDown(@QueryParam("client") Client client); + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/FrontendImpl.java b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/FrontendImpl.java index 22fdc3ee..a316b5f0 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/FrontendImpl.java +++ b/belgif-rest-problem-it/belgif-rest-problem-jakarta-ee-it/src/main/java/io/github/belgif/rest/problem/FrontendImpl.java @@ -14,10 +14,13 @@ import jakarta.ws.rs.Path; import jakarta.ws.rs.PathParam; import jakarta.ws.rs.QueryParam; +import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Response; import org.eclipse.microprofile.rest.client.RestClientBuilder; import org.jboss.resteasy.client.jaxrs.internal.ResteasyClientBuilderImpl; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import com.acme.custom.CustomProblem; @@ -37,6 +40,8 @@ @Path("/frontend") public class FrontendImpl implements Frontend { + private static final Logger LOGGER = LoggerFactory.getLogger(FrontendImpl.class); + private static final URI BASE_URI = URI.create("http://" + System.getProperty("jboss.bind.address") + ":8080/rest-problem"); @@ -266,6 +271,67 @@ public Response jacksonMismatchedInputFromBackend(Client client) { throw new IllegalStateException("Unsupported client " + client); } + @Override + public Response inconsistentProblemStatusFromBackend(Client client) { + try { + if (client == null || client == Client.MICROPROFILE) { + return microprofileClient.inconsistentProblemStatus(); + } else if (client == Client.JAXRS) { + return jaxRsClient.target(BASE_URI).path("backend/inconsistentProblemStatus").request().get(); + } else if (client == Client.JAXRS_ASYNC) { + try { + jaxRsClient.target(BASE_URI).path("backend/inconsistentProblemStatus").request().async().get() + .get(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new RuntimeException(e); + } catch (ExecutionException e) { + throw new RuntimeException(e); + } + } else if (client == Client.RESTEASY) { + return resteasyClient.target(BASE_URI).path("backend/inconsistentProblemStatus").request().get(); + } else if (client == Client.RESTEASY_PROXY) { + return resteasyProxyClient.inconsistentProblemStatus(); + } + throw new IllegalStateException("Unsupported client " + client); + } catch (BadRequestProblem e) { + e.setDetail(e.getDetail() + " (caught successfully by frontend)"); + throw e; + } + } + + @Override + public Response healthDown(@QueryParam("client") Client client) { + try { + if (client == null || client == Client.MICROPROFILE) { + return microprofileClient.healthDown(); + } else if (client == Client.JAXRS) { + return jaxRsClient.target(BASE_URI).path("backend/healthDown").request().get(); + } else if (client == Client.JAXRS_ASYNC) { + try { + return jaxRsClient.target(BASE_URI).path("backend/healthDown").request().async() + .get().get(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new RuntimeException(e); + } catch (ExecutionException e) { + throw new RuntimeException(e); + } + } else if (client == Client.RESTEASY) { + return resteasyClient.target(BASE_URI).path("backend/healthDown").request().get(); + } else if (client == Client.RESTEASY_PROXY) { + return resteasyProxyClient.healthDown(); + } + } catch (WebApplicationException e) { + if (e.getResponse().getStatus() == Response.Status.SERVICE_UNAVAILABLE.getStatusCode()) { + LOGGER.info("Caught WebApplicationException with status 503"); + return e.getResponse(); + } + throw e; + } + throw new IllegalStateException("Unsupported client " + client); + } + @Override public Response beanValidationQueryParameter(Integer p, String o) { return Response.ok("param: " + p + ", other: " + o).build(); diff --git a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/pom.xml b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/pom.xml index 0482f1e9..545700dc 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/pom.xml +++ b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/pom.xml @@ -162,6 +162,12 @@ 8.0.0 provided + + org.slf4j + slf4j-api + 2.0.19 + provided + org.jboss.resteasy resteasy-client-microprofile diff --git a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/Backend.java b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/Backend.java index d18a564d..dc796584 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/Backend.java +++ b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/Backend.java @@ -31,4 +31,12 @@ public interface Backend { @Path("/jacksonMismatchedInput") Response jacksonMismatchedInput(); + @GET + @Path("/inconsistentProblemStatus") + Response inconsistentProblemStatus(); + + @GET + @Path("/healthDown") + Response healthDown(); + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/BackendImpl.java b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/BackendImpl.java index 85741b3e..ffac3286 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/BackendImpl.java +++ b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/BackendImpl.java @@ -1,6 +1,8 @@ package io.github.belgif.rest.problem; import java.net.URI; +import java.util.HashMap; +import java.util.Map; import javax.enterprise.context.RequestScoped; import javax.ws.rs.core.MediaType; @@ -9,6 +11,7 @@ import com.acme.custom.CustomProblem; import io.github.belgif.rest.problem.api.Problem; +import io.github.belgif.rest.problem.it.ProblemPayloads; import io.github.belgif.rest.problem.it.model.JacksonModel; @RequestScoped @@ -56,4 +59,22 @@ public Response jacksonMismatchedInput() { return Response.ok(model, MediaType.APPLICATION_JSON_TYPE).build(); } + @Override + public Response inconsistentProblemStatus() { + return Response.status(402) // -> HTTP status code 402 instead of 400 + .type("application/problem+json") + .entity(ProblemPayloads.INCONSISTENT_STATUS_CODE) // -> problem status code 401 instead of 400 + .build(); + } + + @Override + public Response healthDown() { + Map response = new HashMap<>(); + response.put("status", "DOWN"); + return Response.status(Response.Status.SERVICE_UNAVAILABLE) + .type(MediaType.APPLICATION_JSON_TYPE) + .entity(response) + .build(); + } + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/Frontend.java b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/Frontend.java index 9f0b23bb..3841d281 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/Frontend.java +++ b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/Frontend.java @@ -73,6 +73,10 @@ public interface Frontend { @Path("/jacksonMismatchedInputFromBackend") Response jacksonMismatchedInputFromBackend(@QueryParam("client") Client client); + @GET + @Path("/inconsistentProblemStatusFromBackend") + Response inconsistentProblemStatusFromBackend(@QueryParam("client") Client client); + @GET @Path("/beanValidation/queryParameter") Response beanValidationQueryParameter(@QueryParam("param") @NotNull @Positive Integer p, @@ -118,4 +122,8 @@ Response beanValidationQueryParameter(@QueryParam("param") @NotNull @Positive In @Path("/jackson/mismatchedInputException") Response jacksonMismatchedInputException(@Valid JacksonModel body); + @GET + @Path("/healthDown") + Response healthDown(@QueryParam("client") Client client); + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/FrontendImpl.java b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/FrontendImpl.java index fb151b98..26ec6767 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/FrontendImpl.java +++ b/belgif-rest-problem-it/belgif-rest-problem-java-ee-it/src/main/java/io/github/belgif/rest/problem/FrontendImpl.java @@ -14,10 +14,13 @@ import javax.ws.rs.Path; import javax.ws.rs.PathParam; import javax.ws.rs.QueryParam; +import javax.ws.rs.WebApplicationException; import javax.ws.rs.core.Response; import org.eclipse.microprofile.rest.client.RestClientBuilder; import org.jboss.resteasy.client.jaxrs.ResteasyClientBuilder; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import com.acme.custom.CustomProblem; @@ -37,6 +40,8 @@ @Path("/frontend") public class FrontendImpl implements Frontend { + private static final Logger LOGGER = LoggerFactory.getLogger(FrontendImpl.class); + private static final URI BASE_URI = URI.create("http://" + System.getProperty("jboss.bind.address") + ":8080/rest-problem"); @@ -265,6 +270,67 @@ public Response jacksonMismatchedInputFromBackend(Client client) { throw new IllegalStateException("Unsupported client " + client); } + @Override + public Response inconsistentProblemStatusFromBackend(Client client) { + try { + if (client == null || client == Client.MICROPROFILE) { + return microprofileClient.inconsistentProblemStatus(); + } else if (client == Client.JAXRS) { + return jaxRsClient.target(BASE_URI).path("backend/inconsistentProblemStatus").request().get(); + } else if (client == Client.JAXRS_ASYNC) { + try { + jaxRsClient.target(BASE_URI).path("backend/inconsistentProblemStatus").request().async().get() + .get(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new RuntimeException(e); + } catch (ExecutionException e) { + throw new RuntimeException(e); + } + } else if (client == Client.RESTEASY) { + return resteasyClient.target(BASE_URI).path("backend/inconsistentProblemStatus").request().get(); + } else if (client == Client.RESTEASY_PROXY) { + return resteasyProxyClient.inconsistentProblemStatus(); + } + throw new IllegalStateException("Unsupported client " + client); + } catch (BadRequestProblem e) { + e.setDetail(e.getDetail() + " (caught successfully by frontend)"); + throw e; + } + } + + @Override + public Response healthDown(@QueryParam("client") Client client) { + try { + if (client == null || client == Client.MICROPROFILE) { + return microprofileClient.healthDown(); + } else if (client == Client.JAXRS) { + return jaxRsClient.target(BASE_URI).path("backend/healthDown").request().get(); + } else if (client == Client.JAXRS_ASYNC) { + try { + return jaxRsClient.target(BASE_URI).path("backend/healthDown").request().async() + .get().get(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new RuntimeException(e); + } catch (ExecutionException e) { + throw new RuntimeException(e); + } + } else if (client == Client.RESTEASY) { + return resteasyClient.target(BASE_URI).path("backend/healthDown").request().get(); + } else if (client == Client.RESTEASY_PROXY) { + return resteasyProxyClient.healthDown(); + } + } catch (WebApplicationException e) { + if (e.getResponse().getStatus() == Response.Status.SERVICE_UNAVAILABLE.getStatusCode()) { + LOGGER.info("Caught WebApplicationException with status 503"); + return e.getResponse(); + } + throw e; + } + throw new IllegalStateException("Unsupported client " + client); + } + @Override public Response beanValidationQueryParameter(Integer p, String o) { return Response.ok("param: " + p + ", other: " + o).build(); diff --git a/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/Backend.java b/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/Backend.java index 5a9f2e6d..fc69b97b 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/Backend.java +++ b/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/Backend.java @@ -34,4 +34,12 @@ public interface Backend { @Path("/jacksonMismatchedInput") Response jacksonMismatchedInput(); + @GET + @Path("/inconsistentProblemStatus") + Response inconsistentProblemStatus(); + + @GET + @Path("/healthDown") + Response healthDown(); + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/BackendImpl.java b/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/BackendImpl.java index 8c27c6ce..b9c08e26 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/BackendImpl.java +++ b/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/BackendImpl.java @@ -1,6 +1,8 @@ package io.github.belgif.rest.problem.quarkus.it; import java.net.URI; +import java.util.HashMap; +import java.util.Map; import jakarta.enterprise.context.RequestScoped; import jakarta.ws.rs.core.MediaType; @@ -10,6 +12,7 @@ import io.github.belgif.rest.problem.BadRequestProblem; import io.github.belgif.rest.problem.api.Problem; +import io.github.belgif.rest.problem.it.ProblemPayloads; import io.github.belgif.rest.problem.it.model.JacksonModel; @RequestScoped @@ -57,4 +60,22 @@ public Response jacksonMismatchedInput() { return Response.ok(model, MediaType.APPLICATION_JSON_TYPE).build(); } + @Override + public Response inconsistentProblemStatus() { + return Response.status(402) // -> HTTP status code 402 instead of 400 + .type("application/problem+json") + .entity(ProblemPayloads.INCONSISTENT_STATUS_CODE) // -> problem status code 401 instead of 400 + .build(); + } + + @Override + public Response healthDown() { + Map response = new HashMap<>(); + response.put("status", "DOWN"); + return Response.status(Response.Status.SERVICE_UNAVAILABLE) + .type(MediaType.APPLICATION_JSON_TYPE) + .entity(response) + .build(); + } + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/Frontend.java b/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/Frontend.java index 3036f341..e3bc0324 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/Frontend.java +++ b/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/Frontend.java @@ -69,6 +69,10 @@ public interface Frontend { @Path("/jacksonMismatchedInputFromBackend") Response jacksonMismatchedInputFromBackend(@QueryParam("client") Client client); + @GET + @Path("/inconsistentProblemStatusFromBackend") + Response inconsistentProblemStatusFromBackend(@QueryParam("client") Client client); + @GET @Path("/beanValidation/queryParameter") Response beanValidationQueryParameter(@QueryParam("param") @NotNull @Positive Integer p, @@ -114,4 +118,8 @@ Response beanValidationQueryParameter(@QueryParam("param") @NotNull @Positive In @Path("/jackson/mismatchedInputException") Response jacksonMismatchedInputException(@Valid JacksonModel body); + @GET + @Path("/healthDown") + Response healthDown(@QueryParam("client") Client client); + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/FrontendImpl.java b/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/FrontendImpl.java index a6a37d6c..57208ccf 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/FrontendImpl.java +++ b/belgif-rest-problem-it/belgif-rest-problem-quarkus-it/src/main/java/io/github/belgif/rest/problem/quarkus/it/FrontendImpl.java @@ -15,11 +15,14 @@ import jakarta.ws.rs.Path; import jakarta.ws.rs.PathParam; import jakarta.ws.rs.QueryParam; +import jakarta.ws.rs.WebApplicationException; import jakarta.ws.rs.core.Context; import jakarta.ws.rs.core.Response; import org.eclipse.microprofile.rest.client.RestClientBuilder; import org.eclipse.microprofile.rest.client.inject.RestClient; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import com.acme.custom.CustomProblem; @@ -42,6 +45,8 @@ @Path("/frontend") public class FrontendImpl implements Frontend { + private static final Logger LOGGER = LoggerFactory.getLogger(FrontendImpl.class); + @Context private HttpServerRequest serverRequest; @@ -272,6 +277,67 @@ public Response jacksonMismatchedInputFromBackend(Client client) { throw new IllegalStateException("Unsupported client " + client); } + @Override + public Response inconsistentProblemStatusFromBackend(Client client) { + try { + if (client == null || client == Client.MICROPROFILE) { + return microprofileClient.inconsistentProblemStatus(); + } else if (client == Client.REGISTER_REST_CLIENT) { + return restClientBuilderClient.inconsistentProblemStatus(); + } else if (client == Client.QUARKUS_REST_CLIENT_BUILDER) { + return quarkusRestClientBuilderClient.inconsistentProblemStatus(); + } else if (client == Client.JAXRS) { + return jaxRsClient.target(baseUri).path("backend/inconsistentProblemStatus").request().get(); + } else if (client == Client.JAXRS_ASYNC) { + try { + return jaxRsClient.target(baseUri).path("backend/inconsistentProblemStatus").request().async() + .get().get(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new RuntimeException(e); + } catch (ExecutionException e) { + throw new RuntimeException(e); + } + } + throw new IllegalStateException("Unsupported client " + client); + } catch (BadRequestProblem e) { + e.setDetail(e.getDetail() + " (caught successfully by frontend)"); + throw e; + } + } + + @Override + public Response healthDown(@QueryParam("client") Client client) { + try { + if (client == null || client == Client.MICROPROFILE) { + return microprofileClient.healthDown(); + } else if (client == Client.REGISTER_REST_CLIENT) { + return restClientBuilderClient.healthDown(); + } else if (client == Client.QUARKUS_REST_CLIENT_BUILDER) { + return quarkusRestClientBuilderClient.healthDown(); + } else if (client == Client.JAXRS) { + return jaxRsClient.target(baseUri).path("backend/healthDown").request().get(); + } else if (client == Client.JAXRS_ASYNC) { + try { + return jaxRsClient.target(baseUri).path("backend/healthDown").request().async() + .get().get(); + } catch (InterruptedException e) { + Thread.currentThread().interrupt(); + throw new RuntimeException(e); + } catch (ExecutionException e) { + throw new RuntimeException(e); + } + } + } catch (WebApplicationException e) { + if (e.getResponse().getStatus() == Response.Status.SERVICE_UNAVAILABLE.getStatusCode()) { + LOGGER.info("Caught WebApplicationException with status 503"); + return e.getResponse(); + } + throw e; + } + throw new IllegalStateException("Unsupported client " + client); + } + @Override public Response beanValidationQueryParameter(Integer p, String o) { return Response.ok("param: " + p + ", other: " + o).build(); diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java index 8a627e80..cf60fee5 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java +++ b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java @@ -1,7 +1,9 @@ package io.github.belgif.rest.problem.it; import java.net.URI; +import java.util.Map; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; @@ -12,6 +14,7 @@ import io.github.belgif.rest.problem.BadRequestProblem; import io.github.belgif.rest.problem.api.Problem; import io.github.belgif.rest.problem.it.model.JacksonModel; +import io.github.belgif.rest.problem.spring.ProblemMediaType; @RestController @RequestMapping("/backend") @@ -56,4 +59,19 @@ public ResponseEntity mismatchedInput() { return ResponseEntity.ok(model); } + @GetMapping("/inconsistentProblemStatus") + public ResponseEntity inconsistentProblemStatus() { + return ResponseEntity.status(402) // -> HTTP status code 402 instead of 400 + .contentType(ProblemMediaType.INSTANCE) + .body(ProblemPayloads.INCONSISTENT_STATUS_CODE); // -> problem status code 401 instead of 400 + } + + @GetMapping("/healthDown") + public ResponseEntity> healthDown() { + return ResponseEntity + .status(503) + .contentType(MediaType.APPLICATION_JSON) + .body(Map.of("status", "DOWN")); + } + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java index 69e08e6e..e9efad54 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java +++ b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java @@ -1,15 +1,19 @@ package io.github.belgif.rest.problem.it; import java.net.URI; +import java.util.Map; import jakarta.validation.Valid; import jakarta.validation.constraints.NotNull; import jakarta.validation.constraints.Positive; import jakarta.validation.constraints.Size; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.boot.web.client.RestTemplateBuilder; import org.springframework.boot.web.servlet.context.ServletWebServerInitializedEvent; import org.springframework.context.event.EventListener; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.GetMapping; @@ -23,6 +27,7 @@ import org.springframework.web.client.RestClient; import org.springframework.web.client.RestTemplate; import org.springframework.web.reactive.function.client.WebClient; +import org.springframework.web.reactive.function.client.WebClientResponseException; import com.acme.custom.CustomProblem; @@ -43,6 +48,8 @@ @Validated public class FrontendController implements ControllerInterface { + private static final Logger LOGGER = LoggerFactory.getLogger(FrontendController.class); + private static final String DETAIL_MESSAGE_SUFFIX = " (caught successfully by frontend)"; private static final String ILLEGAL_STATE_MESSAGE_PREFIX = "Unsupported client "; @@ -209,6 +216,44 @@ public void jacksonMismatchedInputFromBackend(@RequestParam("client") Client cli throw new IllegalStateException(ILLEGAL_STATE_MESSAGE_PREFIX + client); } + @GetMapping("/inconsistentProblemStatusFromBackend") + public void inconsistentProblemStatusFromBackend(@RequestParam("client") Client client) { + try { + if (client == Client.REST_TEMPLATE) { + restTemplate.getForObject("/inconsistentProblemStatus", String.class); + } else if (client == Client.WEB_CLIENT) { + webClient.get().uri("/inconsistentProblemStatus").retrieve().toEntity(String.class).block(); + } else if (client == Client.REST_CLIENT) { + restClient.get().uri("/inconsistentProblemStatus").retrieve().toEntity(String.class); + } + throw new IllegalStateException(ILLEGAL_STATE_MESSAGE_PREFIX + client); + } catch (BadRequestProblem e) { + e.setDetail(e.getDetail() + DETAIL_MESSAGE_SUFFIX); + throw e; + } + } + + @GetMapping(value = "/healthDown", produces = "application/json") + public ResponseEntity> healthDown(@RequestParam("client") Client client) { + Map result = null; + if (client == Client.REST_TEMPLATE) { + result = restTemplate.getForObject("/healthDown", Map.class); + } else if (client == Client.WEB_CLIENT) { + try { + result = webClient.get().uri("/healthDown").retrieve().toEntity(Map.class).block().getBody(); + } catch (WebClientResponseException.ServiceUnavailable e) { + LOGGER.info("Caught WebClientResponseException.ServiceUnavailable"); + result = e.getResponseBodyAs(Map.class); + } + } else if (client == Client.REST_CLIENT) { + result = restClient.get().uri("/healthDown").retrieve().toEntity(Map.class).getBody(); + } + return ResponseEntity + .status(503) + .contentType(MediaType.APPLICATION_JSON) + .body(result); + } + @GetMapping("/beanValidation/queryParameter") public ResponseEntity beanValidationQueryParameter( @RequestParam("param") @Positive @NotNull Integer p, diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-4-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-4-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java index 8a627e80..cf60fee5 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-4-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java +++ b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-4-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java @@ -1,7 +1,9 @@ package io.github.belgif.rest.problem.it; import java.net.URI; +import java.util.Map; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; @@ -12,6 +14,7 @@ import io.github.belgif.rest.problem.BadRequestProblem; import io.github.belgif.rest.problem.api.Problem; import io.github.belgif.rest.problem.it.model.JacksonModel; +import io.github.belgif.rest.problem.spring.ProblemMediaType; @RestController @RequestMapping("/backend") @@ -56,4 +59,19 @@ public ResponseEntity mismatchedInput() { return ResponseEntity.ok(model); } + @GetMapping("/inconsistentProblemStatus") + public ResponseEntity inconsistentProblemStatus() { + return ResponseEntity.status(402) // -> HTTP status code 402 instead of 400 + .contentType(ProblemMediaType.INSTANCE) + .body(ProblemPayloads.INCONSISTENT_STATUS_CODE); // -> problem status code 401 instead of 400 + } + + @GetMapping("/healthDown") + public ResponseEntity> healthDown() { + return ResponseEntity + .status(503) + .contentType(MediaType.APPLICATION_JSON) + .body(Map.of("status", "DOWN")); + } + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-4-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-4-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java index 1494824e..c772b50f 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-4-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java +++ b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-4-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java @@ -1,15 +1,19 @@ package io.github.belgif.rest.problem.it; import java.net.URI; +import java.util.Map; import jakarta.validation.Valid; import jakarta.validation.constraints.NotNull; import jakarta.validation.constraints.Positive; import jakarta.validation.constraints.Size; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.boot.restclient.RestTemplateBuilder; import org.springframework.boot.web.server.servlet.context.ServletWebServerInitializedEvent; import org.springframework.context.event.EventListener; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.GetMapping; @@ -23,6 +27,7 @@ import org.springframework.web.client.RestClient; import org.springframework.web.client.RestTemplate; import org.springframework.web.reactive.function.client.WebClient; +import org.springframework.web.reactive.function.client.WebClientResponseException; import com.acme.custom.CustomProblem; @@ -43,6 +48,8 @@ @Validated public class FrontendController implements ControllerInterface { + private static final Logger LOGGER = LoggerFactory.getLogger(FrontendController.class); + private static final String DETAIL_MESSAGE_SUFFIX = " (caught successfully by frontend)"; private static final String ILLEGAL_STATE_MESSAGE_PREFIX = "Unsupported client "; @@ -209,6 +216,44 @@ public void jacksonMismatchedInputFromBackend(@RequestParam("client") Client cli throw new IllegalStateException(ILLEGAL_STATE_MESSAGE_PREFIX + client); } + @GetMapping("/inconsistentProblemStatusFromBackend") + public void inconsistentProblemStatusFromBackend(@RequestParam("client") Client client) { + try { + if (client == Client.REST_TEMPLATE) { + restTemplate.getForObject("/inconsistentProblemStatus", String.class); + } else if (client == Client.WEB_CLIENT) { + webClient.get().uri("/inconsistentProblemStatus").retrieve().toEntity(String.class).block(); + } else if (client == Client.REST_CLIENT) { + restClient.get().uri("/inconsistentProblemStatus").retrieve().toEntity(String.class); + } + throw new IllegalStateException(ILLEGAL_STATE_MESSAGE_PREFIX + client); + } catch (BadRequestProblem e) { + e.setDetail(e.getDetail() + DETAIL_MESSAGE_SUFFIX); + throw e; + } + } + + @GetMapping(value = "/healthDown", produces = "application/json") + public ResponseEntity> healthDown(@RequestParam("client") Client client) { + Map result = null; + if (client == Client.REST_TEMPLATE) { + result = restTemplate.getForObject("/healthDown", Map.class); + } else if (client == Client.WEB_CLIENT) { + try { + result = webClient.get().uri("/healthDown").retrieve().toEntity(Map.class).block().getBody(); + } catch (WebClientResponseException.ServiceUnavailable e) { + LOGGER.info("Caught WebClientResponseException.ServiceUnavailable"); + result = e.getResponseBodyAs(Map.class); + } + } else if (client == Client.REST_CLIENT) { + result = restClient.get().uri("/healthDown").retrieve().toEntity(Map.class).getBody(); + } + return ResponseEntity + .status(503) + .contentType(MediaType.APPLICATION_JSON) + .body(result); + } + @GetMapping("/beanValidation/queryParameter") public ResponseEntity beanValidationQueryParameter( @RequestParam("param") @Positive @NotNull Integer p, diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java index 8a627e80..cf60fee5 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java +++ b/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/BackendController.java @@ -1,7 +1,9 @@ package io.github.belgif.rest.problem.it; import java.net.URI; +import java.util.Map; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; @@ -12,6 +14,7 @@ import io.github.belgif.rest.problem.BadRequestProblem; import io.github.belgif.rest.problem.api.Problem; import io.github.belgif.rest.problem.it.model.JacksonModel; +import io.github.belgif.rest.problem.spring.ProblemMediaType; @RestController @RequestMapping("/backend") @@ -56,4 +59,19 @@ public ResponseEntity mismatchedInput() { return ResponseEntity.ok(model); } + @GetMapping("/inconsistentProblemStatus") + public ResponseEntity inconsistentProblemStatus() { + return ResponseEntity.status(402) // -> HTTP status code 402 instead of 400 + .contentType(ProblemMediaType.INSTANCE) + .body(ProblemPayloads.INCONSISTENT_STATUS_CODE); // -> problem status code 401 instead of 400 + } + + @GetMapping("/healthDown") + public ResponseEntity> healthDown() { + return ResponseEntity + .status(503) + .contentType(MediaType.APPLICATION_JSON) + .body(Map.of("status", "DOWN")); + } + } diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java index 120a3749..d59c2755 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java +++ b/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/FrontendController.java @@ -1,12 +1,16 @@ package io.github.belgif.rest.problem.it; import java.net.URI; +import java.util.Map; import jakarta.validation.Valid; import jakarta.validation.constraints.NotNull; import jakarta.validation.constraints.Positive; import jakarta.validation.constraints.Size; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.GetMapping; @@ -20,6 +24,7 @@ import org.springframework.web.client.RestClient; import org.springframework.web.client.RestTemplate; import org.springframework.web.reactive.function.client.WebClient; +import org.springframework.web.reactive.function.client.WebClientResponseException; import org.springframework.web.util.DefaultUriBuilderFactory; import com.acme.custom.CustomProblem; @@ -42,6 +47,8 @@ @Validated public class FrontendController implements ControllerInterface { + private static final Logger LOGGER = LoggerFactory.getLogger(FrontendController.class); + private static final String DETAIL_MESSAGE_SUFFIX = " (caught successfully by frontend)"; private static final String ILLEGAL_STATE_MESSAGE_PREFIX = "Unsupported client "; @@ -74,6 +81,7 @@ public void initClients(int port) { .build(); this.restTemplate = new RestTemplate(); this.restTemplate.setUriTemplateHandler(new DefaultUriBuilderFactory(apiBaseUrl)); + this.restTemplate.setBufferingPredicate((uri, httpMethod) -> true); this.restTemplate.setErrorHandler(this.errorHandler); } @@ -207,6 +215,44 @@ public void jacksonMismatchedInputFromBackend(@RequestParam("client") Client cli throw new IllegalStateException(ILLEGAL_STATE_MESSAGE_PREFIX + client); } + @GetMapping("/inconsistentProblemStatusFromBackend") + public void inconsistentProblemStatusFromBackend(@RequestParam("client") Client client) { + try { + if (client == Client.REST_TEMPLATE) { + restTemplate.getForObject("/inconsistentProblemStatus", String.class); + } else if (client == Client.WEB_CLIENT) { + webClient.get().uri("/inconsistentProblemStatus").retrieve().toEntity(String.class).block(); + } else if (client == Client.REST_CLIENT) { + restClient.get().uri("/inconsistentProblemStatus").retrieve().toEntity(String.class); + } + throw new IllegalStateException(ILLEGAL_STATE_MESSAGE_PREFIX + client); + } catch (BadRequestProblem e) { + e.setDetail(e.getDetail() + DETAIL_MESSAGE_SUFFIX); + throw e; + } + } + + @GetMapping(value = "/healthDown", produces = "application/json") + public ResponseEntity> healthDown(@RequestParam("client") Client client) { + Map result = null; + if (client == Client.REST_TEMPLATE) { + result = restTemplate.getForObject("/healthDown", Map.class); + } else if (client == Client.WEB_CLIENT) { + try { + result = webClient.get().uri("/healthDown").retrieve().toEntity(Map.class).block().getBody(); + } catch (WebClientResponseException.ServiceUnavailable e) { + LOGGER.info("Caught WebClientResponseException.ServiceUnavailable"); + result = e.getResponseBodyAs(Map.class); + } + } else if (client == Client.REST_CLIENT) { + result = restClient.get().uri("/healthDown").retrieve().toEntity(Map.class).getBody(); + } + return ResponseEntity + .status(503) + .contentType(MediaType.APPLICATION_JSON) + .body(result); + } + @GetMapping("/beanValidation/queryParameter") public ResponseEntity beanValidationQueryParameter( @RequestParam("param") @Positive @NotNull Integer p, diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/WebConfig.java b/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/WebConfig.java index 39589f04..ae848b9c 100644 --- a/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/WebConfig.java +++ b/belgif-rest-problem-it/belgif-rest-problem-spring-it/src/main/java/io/github/belgif/rest/problem/it/WebConfig.java @@ -13,8 +13,8 @@ import io.github.belgif.rest.problem.spring.EnableProblemModule; import io.github.belgif.rest.problem.spring.SpringProblemModuleJackson3; +import io.github.belgif.rest.problem.spring.client.ProblemExchangeFilterFunction; import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; -import io.github.belgif.rest.problem.spring.client.WebClientFilter; import tools.jackson.databind.json.JsonMapper; @Configuration @@ -36,6 +36,7 @@ public RestClient.Builder restClientBuilder(ProblemResponseErrorHandler problemR JsonMapper mapper) { return RestClient.builder() .defaultStatusHandler(problemResponseErrorHandler) + .bufferContent((uri, httpMethod) -> true) .configureMessageConverters(converter -> converter.registerDefaults() .withJsonConverter(new JacksonJsonHttpMessageConverter(mapper))); // change converter with // custom json mapper @@ -48,6 +49,7 @@ public WebClient.Builder webClientBuilder(ProblemResponseErrorHandler problemRes configurer.defaultCodecs().jacksonJsonEncoder(new JacksonJsonEncoder(mapper)); configurer.defaultCodecs().jacksonJsonDecoder(new JacksonJsonDecoder(mapper)); }).build(); - return WebClient.builder().exchangeStrategies(strategies).filter(WebClientFilter.PROBLEM_FILTER); + return WebClient.builder().exchangeStrategies(strategies).filter( + new ProblemExchangeFilterFunction(problemResponseErrorHandler)); } } diff --git a/belgif-rest-problem-java-ee-client/src/main/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemClientResponseFilter.java b/belgif-rest-problem-java-ee-client/src/main/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemClientResponseFilter.java index 3915cfa5..ee3b68c4 100644 --- a/belgif-rest-problem-java-ee-client/src/main/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemClientResponseFilter.java +++ b/belgif-rest-problem-java-ee-client/src/main/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemClientResponseFilter.java @@ -1,6 +1,9 @@ package io.github.belgif.rest.problem.ee.client.jaxrs; +import java.io.ByteArrayInputStream; +import java.io.ByteArrayOutputStream; import java.io.IOException; +import java.io.InputStream; import javax.annotation.PostConstruct; import javax.enterprise.inject.Instance; @@ -15,6 +18,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; import io.github.belgif.rest.problem.DefaultProblem; @@ -22,6 +26,7 @@ import io.github.belgif.rest.problem.ee.core.jaxrs.JaxRsUtil; import io.github.belgif.rest.problem.ee.core.jaxrs.ProblemMediaType; import io.github.belgif.rest.problem.ee.core.jaxrs.ProblemObjectMapper; +import io.github.belgif.rest.problem.internal.Jackson2Util; /** * JAX-RS ClientResponseFilter that converts problem response to a ProblemWrapper exception. @@ -59,11 +64,24 @@ public void filter(ClientRequestContext request, ClientResponseContext response) init(); // because not all JAX-RS implementations honor the @PostConstruct if (ProblemMediaType.INSTANCE.isCompatible(response.getMediaType()) || (response.getStatus() >= 400 && MediaType.APPLICATION_JSON_TYPE.isCompatible(response.getMediaType()))) { - Problem problem = objectMapper.readValue(response.getEntityStream(), Problem.class); - if (problem instanceof DefaultProblem) { - LOGGER.info("No @ProblemType registered for {}: using DefaultProblem fallback", problem.getType()); + InputStream entityStream = response.getEntityStream(); + if (entityStream != null) { + ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); + entityStream.transferTo(outputStream); + byte[] bytes = outputStream.toByteArray(); + // replace the entity stream so it can still be consumed downstream + response.setEntityStream(new ByteArrayInputStream(bytes)); + JsonNode json = objectMapper.readTree(bytes); + if (response.getStatus() == 503 && Jackson2Util.isHealthDownResponse(json)) { + return; + } + Problem problem = objectMapper.treeToValue(json, Problem.class); + if (problem instanceof DefaultProblem) { + LOGGER.info("No @ProblemType registered for {}: using DefaultProblem fallback", problem.getType()); + } + Jackson2Util.checkStatusCodeConsistency(response.getStatus(), json, problem); + throw new ProblemWrapper(problem); } - throw new ProblemWrapper(problem); } } diff --git a/belgif-rest-problem-java-ee-client/src/main/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemResponseExceptionMapper.java b/belgif-rest-problem-java-ee-client/src/main/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemResponseExceptionMapper.java index d2e811ba..827944d3 100644 --- a/belgif-rest-problem-java-ee-client/src/main/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemResponseExceptionMapper.java +++ b/belgif-rest-problem-java-ee-client/src/main/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemResponseExceptionMapper.java @@ -1,15 +1,27 @@ package io.github.belgif.rest.problem.ee.client.jaxrs; +import javax.annotation.PostConstruct; +import javax.enterprise.inject.Instance; +import javax.inject.Inject; +import javax.ws.rs.WebApplicationException; +import javax.ws.rs.core.Context; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; +import javax.ws.rs.ext.Providers; import org.eclipse.microprofile.rest.client.ext.ResponseExceptionMapper; import org.slf4j.Logger; import org.slf4j.LoggerFactory; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; + import io.github.belgif.rest.problem.DefaultProblem; import io.github.belgif.rest.problem.api.Problem; +import io.github.belgif.rest.problem.ee.core.jaxrs.JaxRsUtil; import io.github.belgif.rest.problem.ee.core.jaxrs.ProblemMediaType; +import io.github.belgif.rest.problem.ee.core.jaxrs.ProblemObjectMapper; +import io.github.belgif.rest.problem.internal.Jackson2Util; /** * Client-side problem mapper for MicroProfile REST Client. @@ -17,19 +29,50 @@ * @see ResponseExceptionMapper * @see Problem */ -public class ProblemResponseExceptionMapper implements ResponseExceptionMapper { +public class ProblemResponseExceptionMapper implements ResponseExceptionMapper { private static final Logger LOGGER = LoggerFactory.getLogger(ProblemResponseExceptionMapper.class); + @Inject + private Instance cdiObjectMapper; + + @Context + private Providers providers; + + private volatile ObjectMapper objectMapper; + + @PostConstruct + public void init() { + if (this.objectMapper == null) { + this.objectMapper = JaxRsUtil.locateObjectMapper( + providers, cdiObjectMapper, Problem.class, + MediaType.APPLICATION_JSON_TYPE, () -> ProblemObjectMapper.INSTANCE); + } + } + @Override - public Problem toThrowable(Response response) { + public Exception toThrowable(Response response) { + init(); // because not all JAX-RS implementations honor the @PostConstruct if (ProblemMediaType.INSTANCE.isCompatible(response.getMediaType()) || (response.getStatus() >= 400 && MediaType.APPLICATION_JSON_TYPE.isCompatible(response.getMediaType()))) { - Problem problem = response.readEntity(Problem.class); - if (problem instanceof DefaultProblem) { - LOGGER.info("No @ProblemType registered for {}: using DefaultProblem fallback", problem.getType()); + // buffer the entity so it can still be consumed downstream + response.bufferEntity(); + JsonNode json = response.readEntity(JsonNode.class); + if (response.getStatus() == 503 && Jackson2Util.isHealthDownResponse(json)) { + // We observed issues with some MicroProfile runtimes handling the health DOWN response, so rather + // than returning null and letting the runtime handle it, we directly return WebApplicationException. + return new WebApplicationException(response); + } + try { + Problem problem = objectMapper.treeToValue(json, Problem.class); + if (problem instanceof DefaultProblem) { + LOGGER.info("No @ProblemType registered for {}: using DefaultProblem fallback", problem.getType()); + } + Jackson2Util.checkStatusCodeConsistency(response.getStatus(), json, problem); + return problem; + } catch (Exception e) { + LOGGER.error("Problem reading problem type", e); } - return problem; } return null; } diff --git a/belgif-rest-problem-java-ee-client/src/test/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemClientResponseFilterTest.java b/belgif-rest-problem-java-ee-client/src/test/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemClientResponseFilterTest.java index d56cce6c..350254d0 100644 --- a/belgif-rest-problem-java-ee-client/src/test/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemClientResponseFilterTest.java +++ b/belgif-rest-problem-java-ee-client/src/test/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemClientResponseFilterTest.java @@ -24,7 +24,9 @@ import org.mockito.MockedStatic; import org.mockito.junit.jupiter.MockitoExtension; +import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.JsonNodeFactory; import io.github.belgif.rest.problem.BadRequestProblem; import io.github.belgif.rest.problem.DefaultProblem; @@ -58,8 +60,11 @@ void problemMediaType() throws Exception { when(responseContext.getMediaType()).thenReturn(ProblemMediaType.INSTANCE); InputStream entityStream = new ByteArrayInputStream("dummy".getBytes(StandardCharsets.UTF_8)); when(responseContext.getEntityStream()).thenReturn(entityStream); + JsonNode payload = JsonNodeFactory.instance.objectNode(); + when(objectMapper.readTree("dummy".getBytes(StandardCharsets.UTF_8))) + .thenReturn(payload); Problem problem = new BadRequestProblem(); - when(objectMapper.readValue(entityStream, Problem.class)).thenReturn(problem); + when(objectMapper.treeToValue(payload, Problem.class)).thenReturn(problem); assertThatExceptionOfType(ProblemWrapper.class).isThrownBy( () -> filter.filter(requestContext, responseContext)) .extracting(ProblemWrapper::getProblem) @@ -72,8 +77,11 @@ void jsonMediaTypeErrorStatus() throws Exception { when(responseContext.getStatus()).thenReturn(400); InputStream entityStream = new ByteArrayInputStream("dummy".getBytes(StandardCharsets.UTF_8)); when(responseContext.getEntityStream()).thenReturn(entityStream); + JsonNode payload = JsonNodeFactory.instance.objectNode(); + when(objectMapper.readTree("dummy".getBytes(StandardCharsets.UTF_8))) + .thenReturn(payload); Problem problem = new BadRequestProblem(); - when(objectMapper.readValue(entityStream, Problem.class)).thenReturn(problem); + when(objectMapper.treeToValue(payload, Problem.class)).thenReturn(problem); assertThatExceptionOfType(ProblemWrapper.class).isThrownBy( () -> filter.filter(requestContext, responseContext)) .extracting(ProblemWrapper::getProblem) @@ -94,8 +102,11 @@ void defaultProblem() throws Exception { when(responseContext.getMediaType()).thenReturn(ProblemMediaType.INSTANCE); InputStream entityStream = new ByteArrayInputStream("dummy".getBytes(StandardCharsets.UTF_8)); when(responseContext.getEntityStream()).thenReturn(entityStream); + JsonNode payload = JsonNodeFactory.instance.objectNode(); + when(objectMapper.readTree("dummy".getBytes(StandardCharsets.UTF_8))) + .thenReturn(payload); Problem problem = new DefaultProblem(URI.create("type"), URI.create("href"), "Title", 400); - when(objectMapper.readValue(entityStream, Problem.class)).thenReturn(problem); + when(objectMapper.treeToValue(payload, Problem.class)).thenReturn(problem); assertThatExceptionOfType(ProblemWrapper.class).isThrownBy( () -> filter.filter(requestContext, responseContext)) .extracting(ProblemWrapper::getProblem) @@ -110,6 +121,26 @@ void differentMediaType() { () -> filter.filter(requestContext, responseContext)); } + @Test + void entityStreamNull() { + when(responseContext.getMediaType()).thenReturn(ProblemMediaType.INSTANCE); + when(responseContext.getEntityStream()).thenReturn(null); + assertThatNoException().isThrownBy( + () -> filter.filter(requestContext, responseContext)); + } + + @Test + void healthDownResponse() throws Exception { + when(responseContext.getMediaType()).thenReturn(ProblemMediaType.INSTANCE); + InputStream entityStream = new ByteArrayInputStream("dummy".getBytes(StandardCharsets.UTF_8)); + when(responseContext.getEntityStream()).thenReturn(entityStream); + when(responseContext.getStatus()).thenReturn(503); + JsonNode payload = JsonNodeFactory.instance.objectNode().put("status", "DOWN"); + when(objectMapper.readTree("dummy".getBytes(StandardCharsets.UTF_8))).thenReturn(payload); + assertThatNoException().isThrownBy( + () -> filter.filter(requestContext, responseContext)); + } + @Test void microProfile() { when(requestContext.getProperty("org.eclipse.microprofile.rest.client.invokedMethod")) diff --git a/belgif-rest-problem-java-ee-client/src/test/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemResponseExceptionMapperTest.java b/belgif-rest-problem-java-ee-client/src/test/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemResponseExceptionMapperTest.java index 4b4c42e2..5836ff32 100644 --- a/belgif-rest-problem-java-ee-client/src/test/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemResponseExceptionMapperTest.java +++ b/belgif-rest-problem-java-ee-client/src/test/java/io/github/belgif/rest/problem/ee/client/jaxrs/ProblemResponseExceptionMapperTest.java @@ -3,43 +3,69 @@ import static org.assertj.core.api.Assertions.*; import static org.mockito.Mockito.*; +import java.lang.reflect.Field; import java.net.URI; +import java.util.function.Supplier; +import javax.enterprise.inject.Instance; +import javax.ws.rs.WebApplicationException; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; +import javax.ws.rs.ext.Providers; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; import org.mockito.Mock; +import org.mockito.MockedStatic; import org.mockito.junit.jupiter.MockitoExtension; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.node.JsonNodeFactory; + import io.github.belgif.rest.problem.BadRequestProblem; import io.github.belgif.rest.problem.DefaultProblem; import io.github.belgif.rest.problem.api.Problem; +import io.github.belgif.rest.problem.ee.core.jaxrs.JaxRsUtil; import io.github.belgif.rest.problem.ee.core.jaxrs.ProblemMediaType; @ExtendWith(MockitoExtension.class) class ProblemResponseExceptionMapperTest { - private final ProblemResponseExceptionMapper mapper = new ProblemResponseExceptionMapper(); + @InjectMocks + private ProblemResponseExceptionMapper mapper; @Mock private Response response; + @Mock + private Providers providers; + + @Mock + private Instance cdiObjectMapper; + + @Mock + private ObjectMapper objectMapper; + @Test - void problemMediaType() { + void problemMediaType() throws Exception { when(response.getMediaType()).thenReturn(ProblemMediaType.INSTANCE); + JsonNode payload = JsonNodeFactory.instance.objectNode(); + when(response.readEntity(JsonNode.class)).thenReturn(payload); Problem problem = new BadRequestProblem(); - when(response.readEntity(Problem.class)).thenReturn(problem); + when(objectMapper.treeToValue(payload, Problem.class)).thenReturn(problem); assertThat(mapper.toThrowable(response)).isSameAs(problem); } @Test - void jsonMediaTypeErrorStatus() { + void jsonMediaTypeErrorStatus() throws Exception { when(response.getMediaType()).thenReturn(ProblemMediaType.APPLICATION_JSON_TYPE); when(response.getStatus()).thenReturn(400); + JsonNode payload = JsonNodeFactory.instance.objectNode(); + when(response.readEntity(JsonNode.class)).thenReturn(payload); Problem problem = new BadRequestProblem(); - when(response.readEntity(Problem.class)).thenReturn(problem); + when(objectMapper.treeToValue(payload, Problem.class)).thenReturn(problem); assertThat(mapper.toThrowable(response)).isSameAs(problem); } @@ -51,14 +77,36 @@ void jsonMediaTypeNoErrorStatus() { } @Test - void defaultProblem() { + void defaultProblem() throws Exception { when(response.getMediaType()).thenReturn(ProblemMediaType.APPLICATION_JSON_TYPE); when(response.getStatus()).thenReturn(400); + JsonNode payload = JsonNodeFactory.instance.objectNode(); + when(response.readEntity(JsonNode.class)).thenReturn(payload); Problem problem = new DefaultProblem(URI.create("type"), URI.create("href"), "Title", 400); - when(response.readEntity(Problem.class)).thenReturn(problem); + when(objectMapper.treeToValue(payload, Problem.class)).thenReturn(problem); assertThat(mapper.toThrowable(response)).isSameAs(problem); } + @Test + void healthDownResponse() { + when(response.getMediaType()).thenReturn(ProblemMediaType.APPLICATION_JSON_TYPE); + when(response.getStatus()).thenReturn(503); + when(response.getStatusInfo()).thenReturn(Response.Status.SERVICE_UNAVAILABLE); + JsonNode payload = JsonNodeFactory.instance.objectNode().put("status", "DOWN"); + when(response.readEntity(JsonNode.class)).thenReturn(payload); + WebApplicationException exception = (WebApplicationException) mapper.toThrowable(response); + assertThat(exception.getResponse()).isSameAs(response); + } + + @Test + void exceptionReadingProblem() throws Exception { + when(response.getMediaType()).thenReturn(ProblemMediaType.INSTANCE); + JsonNode payload = JsonNodeFactory.instance.objectNode(); + when(response.readEntity(JsonNode.class)).thenReturn(payload); + when(objectMapper.treeToValue(payload, Problem.class)).thenThrow(new RuntimeException("oops")); + assertThat(mapper.toThrowable(response)).isNull(); + } + @Test void differentMediaType() { when(response.getMediaType()).thenReturn(MediaType.APPLICATION_XML_TYPE); @@ -66,4 +114,20 @@ void differentMediaType() { assertThat(mapper.toThrowable(response)).isNull(); } + @Test + void init() throws Exception { + Field objectMapperField = ProblemResponseExceptionMapper.class.getDeclaredField("objectMapper"); + objectMapperField.setAccessible(true); + objectMapperField.set(mapper, null); + ObjectMapper newMapper = new ObjectMapper(); + try (MockedStatic mock = mockStatic(JaxRsUtil.class)) { + mock.when(() -> JaxRsUtil.locateObjectMapper(eq(providers), eq(cdiObjectMapper), eq(Problem.class), + eq(MediaType.APPLICATION_JSON_TYPE), any(Supplier.class))).thenReturn(newMapper); + mapper.init(); + } + assertThat(mapper).hasFieldOrPropertyWithValue("objectMapper", newMapper); + mapper.init(); + assertThat(mapper).hasFieldOrPropertyWithValue("objectMapper", newMapper); + } + } diff --git a/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ClientProblemAutoConfiguration.java b/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ClientProblemAutoConfiguration.java index 44d1f9a7..94330405 100644 --- a/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ClientProblemAutoConfiguration.java +++ b/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ClientProblemAutoConfiguration.java @@ -15,6 +15,7 @@ import com.fasterxml.jackson.databind.ObjectMapper; import io.github.belgif.rest.problem.spring.ProblemJackson2Configuration; +import io.github.belgif.rest.problem.spring.client.ProblemExchangeFilterFunction; import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; import io.github.belgif.rest.problem.spring.client.ProblemResponseJackson2ErrorHandler; @@ -50,9 +51,11 @@ public static class RestTemplateProblemConfiguration { @ConditionalOnClass({ WebClient.class, WebClientCustomizer.class }) public static class WebClientProblemConfiguration { + @Bean - public ProblemWebClientCustomizer problemWebClientCustomizer() { - return new ProblemWebClientCustomizer(); + public ProblemWebClientCustomizer problemWebClientCustomizer( + ProblemResponseErrorHandler problemResponseErrorHandler) { + return new ProblemWebClientCustomizer(new ProblemExchangeFilterFunction(problemResponseErrorHandler)); } } diff --git a/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizer.java b/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizer.java index 420a0250..9c97d083 100644 --- a/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizer.java +++ b/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizer.java @@ -1,6 +1,8 @@ package io.github.belgif.rest.problem.spring.boot.client; +import org.springframework.boot.http.client.ClientHttpRequestFactoryBuilder; import org.springframework.boot.web.client.RestClientCustomizer; +import org.springframework.http.client.BufferingClientHttpRequestFactory; import org.springframework.web.client.RestClient; import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; @@ -20,5 +22,7 @@ protected ProblemRestClientCustomizer(ProblemResponseErrorHandler errorHandler) public void customize(RestClient.Builder restClientBuilder) { restClientBuilder.defaultStatusHandler(errorHandler); + restClientBuilder.requestFactory( + new BufferingClientHttpRequestFactory(ClientHttpRequestFactoryBuilder.detect().build())); } } diff --git a/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizer.java b/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizer.java index 2c08091f..03c7d769 100644 --- a/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizer.java +++ b/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizer.java @@ -1,6 +1,7 @@ package io.github.belgif.rest.problem.spring.boot.client; import org.springframework.boot.web.client.RestTemplateCustomizer; +import org.springframework.http.client.BufferingClientHttpRequestFactory; import org.springframework.web.client.RestTemplate; import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; @@ -21,6 +22,7 @@ public ProblemRestTemplateCustomizer(ProblemResponseErrorHandler problemResponse public void customize(RestTemplate restTemplate) { restTemplate.setErrorHandler(problemResponseErrorHandler); + restTemplate.setRequestFactory(new BufferingClientHttpRequestFactory(restTemplate.getRequestFactory())); } } diff --git a/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizer.java b/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizer.java index 47301135..38555b47 100644 --- a/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizer.java +++ b/belgif-rest-problem-spring-boot-3-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizer.java @@ -3,14 +3,23 @@ import org.springframework.boot.web.reactive.function.client.WebClientCustomizer; import org.springframework.web.reactive.function.client.WebClient; -import io.github.belgif.rest.problem.spring.client.WebClientFilter; +import io.github.belgif.rest.problem.spring.client.ProblemExchangeFilterFunction; /** * WebClientCustomizer that registers a filter that converts problem responses to Problem exceptions. + * + * @see ProblemExchangeFilterFunction */ public class ProblemWebClientCustomizer implements WebClientCustomizer { + private final ProblemExchangeFilterFunction exchangeFilterFunction; + + public ProblemWebClientCustomizer(ProblemExchangeFilterFunction exchangeFilterFunction) { + this.exchangeFilterFunction = exchangeFilterFunction; + } + public void customize(WebClient.Builder webClientBuilder) { - webClientBuilder.filter(WebClientFilter.PROBLEM_FILTER); + webClientBuilder.filter(exchangeFilterFunction); } + } diff --git a/belgif-rest-problem-spring-boot-3-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizerTest.java b/belgif-rest-problem-spring-boot-3-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizerTest.java new file mode 100644 index 00000000..ad2fb469 --- /dev/null +++ b/belgif-rest-problem-spring-boot-3-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizerTest.java @@ -0,0 +1,26 @@ +package io.github.belgif.rest.problem.spring.boot.client; + +import static org.assertj.core.api.Assertions.*; +import static org.mockito.Mockito.*; + +import org.assertj.core.api.InstanceOfAssertFactories; +import org.junit.jupiter.api.Test; +import org.springframework.web.client.RestClient; + +import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; + +class ProblemRestClientCustomizerTest { + + @Test + void customize() { + ProblemResponseErrorHandler handler = mock(ProblemResponseErrorHandler.class); + ProblemRestClientCustomizer customizer = new ProblemRestClientCustomizer(handler) { + }; + RestClient.Builder builder = RestClient.builder(); + customizer.customize(builder); + + assertThat(builder).extracting("statusHandlers", as(InstanceOfAssertFactories.LIST)) + .hasSize(1); + } + +} diff --git a/belgif-rest-problem-spring-boot-3-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizerTest.java b/belgif-rest-problem-spring-boot-3-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizerTest.java new file mode 100644 index 00000000..25b8d94a --- /dev/null +++ b/belgif-rest-problem-spring-boot-3-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizerTest.java @@ -0,0 +1,24 @@ +package io.github.belgif.rest.problem.spring.boot.client; + +import static org.assertj.core.api.Assertions.*; +import static org.mockito.Mockito.*; + +import org.junit.jupiter.api.Test; +import org.springframework.web.client.RestTemplate; + +import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; + +class ProblemRestTemplateCustomizerTest { + + @Test + void customize() { + ProblemResponseErrorHandler handler = mock(ProblemResponseErrorHandler.class); + ProblemRestTemplateCustomizer customizer = new ProblemRestTemplateCustomizer(handler) { + }; + RestTemplate restTemplate = new RestTemplate(); + customizer.customize(restTemplate); + + assertThat(restTemplate.getErrorHandler()).isSameAs(handler); + } + +} diff --git a/belgif-rest-problem-spring-boot-3-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizerTest.java b/belgif-rest-problem-spring-boot-3-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizerTest.java new file mode 100644 index 00000000..cf356885 --- /dev/null +++ b/belgif-rest-problem-spring-boot-3-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizerTest.java @@ -0,0 +1,33 @@ +package io.github.belgif.rest.problem.spring.boot.client; + +import static org.assertj.core.api.Assertions.*; + +import org.assertj.core.api.InstanceOfAssertFactories; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.web.reactive.function.client.WebClient; + +import io.github.belgif.rest.problem.spring.client.ProblemExchangeFilterFunction; + +@ExtendWith(MockitoExtension.class) +class ProblemWebClientCustomizerTest { + + @InjectMocks + private ProblemWebClientCustomizer customizer; + + @Mock + private ProblemExchangeFilterFunction exchangeFilterFunction; + + @Test + void customize() { + WebClient.Builder builder = WebClient.builder(); + customizer.customize(builder); + + assertThat(builder).extracting("filters", as(InstanceOfAssertFactories.LIST)) + .containsExactly(exchangeFilterFunction); + } + +} diff --git a/belgif-rest-problem-spring-boot-3-server-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/server/ProblemValidationConfigurationCustomizerTest.java b/belgif-rest-problem-spring-boot-3-server-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/server/ProblemValidationConfigurationCustomizerTest.java new file mode 100644 index 00000000..cc1d7150 --- /dev/null +++ b/belgif-rest-problem-spring-boot-3-server-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/server/ProblemValidationConfigurationCustomizerTest.java @@ -0,0 +1,37 @@ +package io.github.belgif.rest.problem.spring.boot.server; + +import static org.assertj.core.api.Assertions.*; +import static org.mockito.Mockito.*; + +import jakarta.validation.Configuration; +import jakarta.validation.ParameterNameProvider; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.ArgumentCaptor; +import org.mockito.Captor; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; + +import io.github.belgif.rest.problem.spring.server.AnnotationParameterNameProvider; + +@ExtendWith(MockitoExtension.class) +class ProblemValidationConfigurationCustomizerTest { + + private final ProblemValidationConfigurationCustomizer customizer = + new ProblemValidationConfigurationCustomizer(); + + @Mock + private Configuration configuration; + + @Captor + private ArgumentCaptor parameterNameProviderCaptor; + + @Test + void customize() { + when(configuration.parameterNameProvider(parameterNameProviderCaptor.capture())).thenReturn(configuration); + customizer.customize(configuration); + assertThat(parameterNameProviderCaptor.getValue()).isInstanceOf(AnnotationParameterNameProvider.class); + } + +} diff --git a/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ClientProblemAutoConfiguration.java b/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ClientProblemAutoConfiguration.java index edf18d22..8697fc35 100644 --- a/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ClientProblemAutoConfiguration.java +++ b/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ClientProblemAutoConfiguration.java @@ -12,6 +12,7 @@ import org.springframework.web.client.RestTemplate; import org.springframework.web.reactive.function.client.WebClient; +import io.github.belgif.rest.problem.spring.client.ProblemExchangeFilterFunction; import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; import io.github.belgif.rest.problem.spring.client.ProblemResponseJackson3ErrorHandler; import tools.jackson.databind.ObjectMapper; @@ -49,8 +50,9 @@ public static class RestTemplateProblemConfiguration { @ConditionalOnClass({ WebClient.class, WebClientCustomizer.class }) public static class WebClientProblemConfiguration { @Bean - public ProblemWebClientCustomizer problemWebClientCustomizer() { - return new ProblemWebClientCustomizer(); + public ProblemWebClientCustomizer problemWebClientCustomizer( + ProblemResponseErrorHandler problemResponseErrorHandler) { + return new ProblemWebClientCustomizer(new ProblemExchangeFilterFunction(problemResponseErrorHandler)); } } diff --git a/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizer.java b/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizer.java index b396d2d7..70ef6195 100644 --- a/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizer.java +++ b/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizer.java @@ -20,6 +20,7 @@ protected ProblemRestClientCustomizer(ProblemResponseErrorHandler errorHandler) public void customize(RestClient.Builder restClientBuilder) { restClientBuilder.defaultStatusHandler(errorHandler); + restClientBuilder.bufferContent(((uri, httpMethod) -> true)); } } diff --git a/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizer.java b/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizer.java index 3e1bf444..c9e144e7 100644 --- a/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizer.java +++ b/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestTemplateCustomizer.java @@ -21,6 +21,7 @@ public ProblemRestTemplateCustomizer(ProblemResponseErrorHandler problemResponse public void customize(RestTemplate restTemplate) { restTemplate.setErrorHandler(problemResponseErrorHandler); + restTemplate.setBufferingPredicate((uri, httpMethod) -> true); } } diff --git a/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizer.java b/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizer.java index fe05a879..08536c8e 100644 --- a/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizer.java +++ b/belgif-rest-problem-spring-boot-4-client-starter/src/main/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizer.java @@ -3,15 +3,21 @@ import org.springframework.boot.webclient.WebClientCustomizer; import org.springframework.web.reactive.function.client.WebClient; -import io.github.belgif.rest.problem.spring.client.WebClientFilter; +import io.github.belgif.rest.problem.spring.client.ProblemExchangeFilterFunction; /** * WebClientCustomizer that registers a filter that converts problem responses to Problem exceptions. */ public class ProblemWebClientCustomizer implements WebClientCustomizer { + private final ProblemExchangeFilterFunction exchangeFilterFunction; + + public ProblemWebClientCustomizer(ProblemExchangeFilterFunction exchangeFilterFunction) { + this.exchangeFilterFunction = exchangeFilterFunction; + } + public void customize(WebClient.Builder webClientBuilder) { - webClientBuilder.filter(WebClientFilter.PROBLEM_FILTER); + webClientBuilder.filter(exchangeFilterFunction); } } diff --git a/belgif-rest-problem-spring-boot-4-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizerTest.java b/belgif-rest-problem-spring-boot-4-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizerTest.java index e60d1288..ad2fb469 100644 --- a/belgif-rest-problem-spring-boot-4-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizerTest.java +++ b/belgif-rest-problem-spring-boot-4-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemRestClientCustomizerTest.java @@ -3,10 +3,8 @@ import static org.assertj.core.api.Assertions.*; import static org.mockito.Mockito.*; -import java.util.List; - +import org.assertj.core.api.InstanceOfAssertFactories; import org.junit.jupiter.api.Test; -import org.springframework.test.util.ReflectionTestUtils; import org.springframework.web.client.RestClient; import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; @@ -21,8 +19,8 @@ void customize() { RestClient.Builder builder = RestClient.builder(); customizer.customize(builder); - List statusHandlers = (List) ReflectionTestUtils.getField(builder, "statusHandlers"); - assertThat(statusHandlers).hasSize(1); + assertThat(builder).extracting("statusHandlers", as(InstanceOfAssertFactories.LIST)) + .hasSize(1); } } diff --git a/belgif-rest-problem-spring-boot-4-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizerTest.java b/belgif-rest-problem-spring-boot-4-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizerTest.java index b7a49275..cf356885 100644 --- a/belgif-rest-problem-spring-boot-4-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizerTest.java +++ b/belgif-rest-problem-spring-boot-4-client-starter/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemWebClientCustomizerTest.java @@ -1,110 +1,33 @@ package io.github.belgif.rest.problem.spring.boot.client; import static org.assertj.core.api.Assertions.*; -import static org.mockito.Mockito.*; +import org.assertj.core.api.InstanceOfAssertFactories; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.ExtendWith; -import org.mockito.ArgumentCaptor; -import org.mockito.Captor; +import org.mockito.InjectMocks; import org.mockito.Mock; import org.mockito.junit.jupiter.MockitoExtension; -import org.springframework.http.HttpStatus; -import org.springframework.web.reactive.function.client.ClientRequest; -import org.springframework.web.reactive.function.client.ClientResponse; -import org.springframework.web.reactive.function.client.ExchangeFilterFunction; -import org.springframework.web.reactive.function.client.ExchangeFunction; import org.springframework.web.reactive.function.client.WebClient; -import io.github.belgif.rest.problem.api.Problem; -import reactor.core.publisher.Mono; +import io.github.belgif.rest.problem.spring.client.ProblemExchangeFilterFunction; @ExtendWith(MockitoExtension.class) class ProblemWebClientCustomizerTest { - private final ProblemWebClientCustomizer customizer = new ProblemWebClientCustomizer() { - }; + @InjectMocks + private ProblemWebClientCustomizer customizer; @Mock - private WebClient.Builder builder; - - @Mock - private ExchangeFunction exchangeFunction; - - @Mock - private ClientRequest request; - - @Captor - private ArgumentCaptor filterCaptor; - - @Test - void problemMediaType() { - customizer.customize(builder); - verify(builder).filter(filterCaptor.capture()); - ExchangeFilterFunction filter = filterCaptor.getValue(); - assertThat(filter).isNotNull(); - - ClientResponse response = ClientResponse.create(HttpStatus.BAD_REQUEST) - .header("Content-Type", "application/problem+json") - .body("{}") - .build(); - when(exchangeFunction.exchange(request)).thenReturn(Mono.just(response)); - Mono result = filter.filter(request, exchangeFunction); - - assertThatExceptionOfType(Problem.class) - .isThrownBy(result::block); - } - - @Test - void jsonMediaTypeErrorStatus() { - customizer.customize(builder); - verify(builder).filter(filterCaptor.capture()); - ExchangeFilterFunction filter = filterCaptor.getValue(); - assertThat(filter).isNotNull(); - - ClientResponse response = ClientResponse.create(HttpStatus.BAD_REQUEST) - .header("Content-Type", "application/json") - .body("{}") - .build(); - when(exchangeFunction.exchange(request)).thenReturn(Mono.just(response)); - Mono result = filter.filter(request, exchangeFunction); - - assertThatExceptionOfType(Problem.class) - .isThrownBy(result::block); - } - - @Test - void jsonMediaTypeNoErrorStatus() { - customizer.customize(builder); - verify(builder).filter(filterCaptor.capture()); - ExchangeFilterFunction filter = filterCaptor.getValue(); - assertThat(filter).isNotNull(); - - ClientResponse response = ClientResponse.create(HttpStatus.OK) - .header("Content-Type", "application/json") - .body("{}") - .build(); - when(exchangeFunction.exchange(request)).thenReturn(Mono.just(response)); - Mono result = filter.filter(request, exchangeFunction); - - assertThat(result.block()).isEqualTo(response); - } + private ProblemExchangeFilterFunction exchangeFilterFunction; @Test - void differentMediaType() { + void customize() { + WebClient.Builder builder = WebClient.builder(); customizer.customize(builder); - verify(builder).filter(filterCaptor.capture()); - ExchangeFilterFunction filter = filterCaptor.getValue(); - assertThat(filter).isNotNull(); - - ClientResponse response = ClientResponse.create(HttpStatus.OK) - .header("Content-Type", "application/xml") - .body("{}") - .build(); - when(exchangeFunction.exchange(request)).thenReturn(Mono.just(response)); - Mono result = filter.filter(request, exchangeFunction); - assertThat(result.block()).isEqualTo(response); + assertThat(builder).extracting("filters", as(InstanceOfAssertFactories.LIST)) + .containsExactly(exchangeFilterFunction); } } diff --git a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/EnableProblemModule.java b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/EnableProblemModule.java index 8a3d0d6b..a46edda1 100644 --- a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/EnableProblemModule.java +++ b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/EnableProblemModule.java @@ -51,8 +51,8 @@ * Creates support beans for REST clients. * Requires: * - setting ProblemResponseErrorHandler as defaultStatusHandler on the client - * - or for {@link org.springframework.web.reactive.function.client.WebClient}, setting PROBLEM_FILTER from - * {@link io.github.belgif.rest.problem.spring.client.WebClientFilter} + * - or for {@link org.springframework.web.reactive.function.client.WebClient}, setting + * {@link io.github.belgif.rest.problem.spring.client.ProblemExchangeFilterFunction} */ boolean client() default true; diff --git a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/AbstractProblemResponseErrorHandler.java b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/AbstractProblemResponseErrorHandler.java index e7987027..45d08613 100644 --- a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/AbstractProblemResponseErrorHandler.java +++ b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/AbstractProblemResponseErrorHandler.java @@ -1,48 +1,31 @@ package io.github.belgif.rest.problem.spring.client; import java.io.IOException; -import java.io.InputStream; import java.net.URI; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; import org.springframework.http.HttpMethod; import org.springframework.http.MediaType; import org.springframework.http.client.ClientHttpResponse; import org.springframework.web.client.DefaultResponseErrorHandler; -import io.github.belgif.rest.problem.DefaultProblem; import io.github.belgif.rest.problem.api.Problem; import io.github.belgif.rest.problem.spring.ProblemMediaType; public abstract class AbstractProblemResponseErrorHandler extends DefaultResponseErrorHandler implements ProblemResponseErrorHandler { - private static final Logger LOGGER = LoggerFactory.getLogger(AbstractProblemResponseErrorHandler.class); - - private final ProblemReader problemReader; - - protected AbstractProblemResponseErrorHandler(ProblemReader problemReader) { - this.problemReader = problemReader; - } - @Override public void handleError(URI url, HttpMethod method, ClientHttpResponse response) throws IOException { if (ProblemMediaType.INSTANCE.isCompatibleWith(response.getHeaders().getContentType()) || response.getStatusCode().isError() && MediaType.APPLICATION_JSON.isCompatibleWith(response.getHeaders().getContentType())) { - Problem problem = problemReader.read(response.getBody()); - if (problem instanceof DefaultProblem) { - LOGGER.info("No @ProblemType registered for {}: using DefaultProblem fallback", problem.getType()); + Problem problem = handleProblem(response.getStatusCode().value(), response.getBody()); + if (problem == null) { + return; } throw problem; } super.handleError(url, method, response); } - @FunctionalInterface - public interface ProblemReader { - Problem read(InputStream body) throws IOException; - } - } diff --git a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemExchangeFilterFunction.java b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemExchangeFilterFunction.java new file mode 100644 index 00000000..f01de74b --- /dev/null +++ b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemExchangeFilterFunction.java @@ -0,0 +1,75 @@ +package io.github.belgif.rest.problem.spring.client; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.UncheckedIOException; + +import org.springframework.core.io.buffer.DataBufferUtils; +import org.springframework.core.io.buffer.DefaultDataBufferFactory; +import org.springframework.http.MediaType; +import org.springframework.stereotype.Component; +import org.springframework.web.reactive.function.BodyExtractors; +import org.springframework.web.reactive.function.client.ClientRequest; +import org.springframework.web.reactive.function.client.ClientResponse; +import org.springframework.web.reactive.function.client.ExchangeFilterFunction; +import org.springframework.web.reactive.function.client.ExchangeFunction; + +import io.github.belgif.rest.problem.api.Problem; +import io.github.belgif.rest.problem.spring.ProblemMediaType; +import reactor.core.publisher.Flux; +import reactor.core.publisher.Mono; + +/** + * ExchangeFilterFunction that converts problem responses to Problem exceptions for reactive WebClient. + */ +@Component +public class ProblemExchangeFilterFunction implements ExchangeFilterFunction { + + private final ProblemResponseErrorHandler errorHandler; + + public ProblemExchangeFilterFunction(ProblemResponseErrorHandler errorHandler) { + this.errorHandler = errorHandler; + } + + @Override + public Mono filter(ClientRequest request, ExchangeFunction next) { + return next.exchange(request).flatMap(this::handleResponse); + } + + private Mono handleResponse(ClientResponse response) { + MediaType mediaType = response.headers().contentType().orElse(null); + if (ProblemMediaType.INSTANCE.isCompatibleWith(mediaType) + || (response.statusCode().isError() && MediaType.APPLICATION_JSON.isCompatibleWith(mediaType))) { + return DataBufferUtils.join(response.body(BodyExtractors.toDataBuffers())) + .defaultIfEmpty(new DefaultDataBufferFactory().wrap(new byte[0])) + .flatMap(dataBuffer -> { + byte[] bytes = new byte[dataBuffer.readableByteCount()]; + dataBuffer.read(bytes); + DataBufferUtils.release(dataBuffer); + Problem problem; + try { + problem = errorHandler.handleProblem( + response.statusCode().value(), new ByteArrayInputStream(bytes)); + } catch (IOException e) { + return Mono.error(new UncheckedIOException(e)); + } + if (problem != null) { + return Mono.error(problem); + } + ClientResponse rebuilt = ClientResponse + .create(response.statusCode()) + // not using putAll() for headers because it results in IncompatibleClassChangeError: + // Class org.springframework.http.ReadOnlyHttpHeaders does not implement + // the requested interface java.util.Map + .headers(headers -> response.headers().asHttpHeaders() + .forEach((name, values) -> values.forEach(value -> headers.add(name, value)))) + .cookies(cookies -> cookies.putAll(response.cookies())) + .body(Flux.just(new DefaultDataBufferFactory().wrap(bytes))) + .build(); + return Mono.just(rebuilt); + }); + } + return Mono.just(response); + } + +} diff --git a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseErrorHandler.java b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseErrorHandler.java index f37478fd..47759442 100644 --- a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseErrorHandler.java +++ b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseErrorHandler.java @@ -1,9 +1,17 @@ package io.github.belgif.rest.problem.spring.client; +import java.io.IOException; +import java.io.InputStream; + import org.springframework.web.client.ResponseErrorHandler; +import io.github.belgif.rest.problem.api.Problem; + /** * RestTemplate/RestClient error handler that converts problem responses to Problem exceptions. */ public interface ProblemResponseErrorHandler extends ResponseErrorHandler { + + Problem handleProblem(int httpStatusCode, InputStream inputStream) throws IOException; + } diff --git a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseJackson2ErrorHandler.java b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseJackson2ErrorHandler.java index 7b1ef42e..e2f354ec 100644 --- a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseJackson2ErrorHandler.java +++ b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseJackson2ErrorHandler.java @@ -1,10 +1,18 @@ package io.github.belgif.rest.problem.spring.client; +import java.io.IOException; +import java.io.InputStream; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component; +import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.ObjectMapper; +import io.github.belgif.rest.problem.DefaultProblem; import io.github.belgif.rest.problem.api.Problem; +import io.github.belgif.rest.problem.internal.Jackson2Util; /** * RestTemplate/RestClient error handler that converts problem responses to Problem exceptions. @@ -12,8 +20,26 @@ @Component public class ProblemResponseJackson2ErrorHandler extends AbstractProblemResponseErrorHandler { + private static final Logger LOGGER = LoggerFactory.getLogger(ProblemResponseJackson2ErrorHandler.class); + + private final ObjectMapper objectMapper; + public ProblemResponseJackson2ErrorHandler(ObjectMapper objectMapper) { - super(input -> objectMapper.readValue(input, Problem.class)); + this.objectMapper = objectMapper; + } + + @Override + public Problem handleProblem(int httpStatusCode, InputStream inputStream) throws IOException { + JsonNode json = objectMapper.readTree(inputStream); + if (httpStatusCode == 503 && Jackson2Util.isHealthDownResponse(json)) { + return null; + } + Problem problem = objectMapper.convertValue(json, Problem.class); + if (problem instanceof DefaultProblem) { + LOGGER.info("No @ProblemType registered for {}: using DefaultProblem fallback", problem.getType()); + } + Jackson2Util.checkStatusCodeConsistency(httpStatusCode, json, problem); + return problem; } } diff --git a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseJackson3ErrorHandler.java b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseJackson3ErrorHandler.java index 9a72d778..f025e5be 100644 --- a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseJackson3ErrorHandler.java +++ b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/ProblemResponseJackson3ErrorHandler.java @@ -1,8 +1,15 @@ package io.github.belgif.rest.problem.spring.client; +import java.io.InputStream; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component; +import io.github.belgif.rest.problem.DefaultProblem; import io.github.belgif.rest.problem.api.Problem; +import io.github.belgif.rest.problem.internal.Jackson3Util; +import tools.jackson.databind.JsonNode; import tools.jackson.databind.ObjectMapper; /** @@ -11,8 +18,26 @@ @Component public class ProblemResponseJackson3ErrorHandler extends AbstractProblemResponseErrorHandler { + private static final Logger LOGGER = LoggerFactory.getLogger(ProblemResponseJackson3ErrorHandler.class); + + private final ObjectMapper objectMapper; + public ProblemResponseJackson3ErrorHandler(ObjectMapper objectMapper) { - super(input -> objectMapper.readValue(input, Problem.class)); + this.objectMapper = objectMapper; + } + + @Override + public Problem handleProblem(int httpStatusCode, InputStream inputStream) { + JsonNode json = objectMapper.readTree(inputStream); + if (httpStatusCode == 503 && Jackson3Util.isHealthDownResponse(json)) { + return null; + } + Problem problem = objectMapper.convertValue(json, Problem.class); + if (problem instanceof DefaultProblem) { + LOGGER.info("No @ProblemType registered for {}: using DefaultProblem fallback", problem.getType()); + } + Jackson3Util.checkStatusCodeConsistency(httpStatusCode, json, problem); + return problem; } } diff --git a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/WebClientFilter.java b/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/WebClientFilter.java deleted file mode 100644 index 9dd9bf81..00000000 --- a/belgif-rest-problem-spring/src/main/java/io/github/belgif/rest/problem/spring/client/WebClientFilter.java +++ /dev/null @@ -1,21 +0,0 @@ -package io.github.belgif.rest.problem.spring.client; - -import org.springframework.http.MediaType; -import org.springframework.web.reactive.function.client.ExchangeFilterFunction; - -import io.github.belgif.rest.problem.api.Problem; -import io.github.belgif.rest.problem.spring.ProblemMediaType; -import reactor.core.publisher.Mono; - -public class WebClientFilter { - public static final ExchangeFilterFunction PROBLEM_FILTER = - ExchangeFilterFunction.ofResponseProcessor(response -> { - MediaType mediaType = response.headers().contentType().orElse(null); - if (ProblemMediaType.INSTANCE.isCompatibleWith(mediaType) - || response.statusCode().isError() && MediaType.APPLICATION_JSON.isCompatibleWith(mediaType)) { - return response.bodyToMono(Problem.class).flatMap(Mono::error); - } else { - return Mono.just(response); - } - }); -} diff --git a/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/AbstractProblemResponseErrorHandlerTest.java b/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/AbstractProblemResponseErrorHandlerTest.java new file mode 100644 index 00000000..09a6531b --- /dev/null +++ b/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/AbstractProblemResponseErrorHandlerTest.java @@ -0,0 +1,83 @@ +package io.github.belgif.rest.problem.spring.boot.client; + +import static org.assertj.core.api.Assertions.*; +import static org.mockito.Mockito.*; + +import java.io.ByteArrayInputStream; +import java.net.URI; +import java.nio.charset.StandardCharsets; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpMethod; +import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; +import org.springframework.http.client.ClientHttpResponse; +import org.springframework.web.client.HttpClientErrorException; + +import io.github.belgif.rest.problem.BadRequestProblem; +import io.github.belgif.rest.problem.DefaultProblem; +import io.github.belgif.rest.problem.spring.ProblemMediaType; +import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; + +@ExtendWith(MockitoExtension.class) +abstract class AbstractProblemResponseErrorHandlerTest { + + private final ProblemResponseErrorHandler handler; + + @Mock + private ClientHttpResponse response; + + @Mock + private HttpHeaders headers; + + protected AbstractProblemResponseErrorHandlerTest(ProblemResponseErrorHandler handler) { + this.handler = handler; + } + + @Test + void differentContentType() throws Exception { + when(response.getHeaders()).thenReturn(headers); + when(headers.getContentType()).thenReturn(MediaType.APPLICATION_XML); + when(response.getStatusCode()).thenReturn(HttpStatus.BAD_REQUEST); + assertThatExceptionOfType(HttpClientErrorException.BadRequest.class) + .isThrownBy(() -> handler.handleError(URI.create("http://test"), HttpMethod.GET, response)); + } + + @Test + void problemContentType() throws Exception { + when(response.getHeaders()).thenReturn(headers); + when(headers.getContentType()).thenReturn(ProblemMediaType.APPLICATION_PROBLEM_JSON); + when(response.getStatusCode()).thenReturn(HttpStatus.BAD_REQUEST); + when(response.getBody()).thenReturn(new ByteArrayInputStream( + "{ \"type\": \"urn:problem-type:belgif:badRequest\" }".getBytes(StandardCharsets.UTF_8))); + assertThatExceptionOfType(BadRequestProblem.class) + .isThrownBy(() -> handler.handleError(URI.create("http://test"), HttpMethod.GET, response)); + } + + @Test + void defaultProblem() throws Exception { + when(response.getHeaders()).thenReturn(headers); + when(headers.getContentType()).thenReturn(ProblemMediaType.APPLICATION_PROBLEM_JSON); + when(response.getStatusCode()).thenReturn(HttpStatus.BAD_REQUEST); + when(response.getBody()).thenReturn(new ByteArrayInputStream( + "{ \"type\": \"urn:problem-type:belgif:foo\" }".getBytes(StandardCharsets.UTF_8))); + assertThatExceptionOfType(DefaultProblem.class) + .isThrownBy(() -> handler.handleError(URI.create("http://test"), HttpMethod.GET, response)); + } + + @Test + void healthDown() throws Exception { + when(response.getHeaders()).thenReturn(headers); + when(headers.getContentType()).thenReturn(MediaType.APPLICATION_JSON); + when(response.getStatusCode()).thenReturn(HttpStatus.SERVICE_UNAVAILABLE); + when(response.getBody()).thenReturn(new ByteArrayInputStream( + "{ \"status\": \"DOWN\" }".getBytes(StandardCharsets.UTF_8))); + assertThatNoException() + .isThrownBy(() -> handler.handleError(URI.create("http://test"), HttpMethod.GET, response)); + } + +} diff --git a/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemExchangeFilterFunctionTest.java b/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemExchangeFilterFunctionTest.java new file mode 100644 index 00000000..a6cf2066 --- /dev/null +++ b/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemExchangeFilterFunctionTest.java @@ -0,0 +1,110 @@ +package io.github.belgif.rest.problem.spring.boot.client; + +import static org.assertj.core.api.Assertions.*; +import static org.mockito.Mockito.*; + +import java.io.InputStream; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.ExtendWith; +import org.mockito.InjectMocks; +import org.mockito.Mock; +import org.mockito.junit.jupiter.MockitoExtension; +import org.springframework.http.HttpStatus; +import org.springframework.web.reactive.function.client.ClientRequest; +import org.springframework.web.reactive.function.client.ClientResponse; +import org.springframework.web.reactive.function.client.ExchangeFunction; + +import io.github.belgif.rest.problem.BadRequestProblem; +import io.github.belgif.rest.problem.api.Problem; +import io.github.belgif.rest.problem.spring.client.ProblemExchangeFilterFunction; +import io.github.belgif.rest.problem.spring.client.ProblemResponseErrorHandler; +import reactor.core.publisher.Mono; + +@ExtendWith(MockitoExtension.class) +class ProblemExchangeFilterFunctionTest { + + @InjectMocks + private ProblemExchangeFilterFunction filter; + + @Mock + private ProblemResponseErrorHandler problemResponseErrorHandler; + + @Mock + private ExchangeFunction exchangeFunction; + + @Mock + private ClientRequest request; + + @Test + void problemMediaType() throws Exception { + ClientResponse response = ClientResponse.create(HttpStatus.BAD_REQUEST) + .header("Content-Type", "application/problem+json") + .body("{}") + .build(); + when(exchangeFunction.exchange(request)).thenReturn(Mono.just(response)); + Problem problem = new BadRequestProblem(); + when(problemResponseErrorHandler.handleProblem(eq(400), any(InputStream.class))).thenReturn(problem); + + Mono result = filter.filter(request, exchangeFunction); + + assertThatException().isThrownBy(result::block).isEqualTo(problem); + } + + @Test + void jsonMediaTypeErrorStatus() throws Exception { + ClientResponse response = ClientResponse.create(HttpStatus.BAD_REQUEST) + .header("Content-Type", "application/json") + .body("{}") + .build(); + when(exchangeFunction.exchange(request)).thenReturn(Mono.just(response)); + Problem problem = new BadRequestProblem(); + when(problemResponseErrorHandler.handleProblem(eq(400), any(InputStream.class))).thenReturn(problem); + + Mono result = filter.filter(request, exchangeFunction); + + assertThatException().isThrownBy(result::block).isEqualTo(problem); + } + + @Test + void jsonMediaTypeNoErrorStatus() { + ClientResponse response = ClientResponse.create(HttpStatus.OK) + .header("Content-Type", "application/json") + .body("{}") + .build(); + when(exchangeFunction.exchange(request)).thenReturn(Mono.just(response)); + Mono result = filter.filter(request, exchangeFunction); + + assertThat(result.block()).isEqualTo(response); + } + + @Test + void differentMediaType() { + ClientResponse response = ClientResponse.create(HttpStatus.OK) + .header("Content-Type", "application/xml") + .body("{}") + .build(); + when(exchangeFunction.exchange(request)).thenReturn(Mono.just(response)); + Mono result = filter.filter(request, exchangeFunction); + + assertThat(result.block()).isEqualTo(response); + } + + @Test + void healthDown() throws Exception { + ClientResponse response = ClientResponse.create(HttpStatus.SERVICE_UNAVAILABLE) + .header("Content-Type", "application/json") + .header("Test", "foo") + .cookie("Cookie", "value") + .body("{ \"status\" : \"DOWN\" }") + .build(); + when(exchangeFunction.exchange(request)).thenReturn(Mono.just(response)); + when(problemResponseErrorHandler.handleProblem(eq(503), any(InputStream.class))).thenReturn(null); + + ClientResponse result = filter.filter(request, exchangeFunction).block(); + assertThat(result.statusCode().value()).isEqualTo(503); + assertThat(result.headers().asHttpHeaders()).isEqualTo(response.headers().asHttpHeaders()); + assertThat(result.cookies()).isEqualTo(response.cookies()); + } + +} diff --git a/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemResponseJackson2ErrorHandlerTest.java b/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemResponseJackson2ErrorHandlerTest.java new file mode 100644 index 00000000..216a35d8 --- /dev/null +++ b/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemResponseJackson2ErrorHandlerTest.java @@ -0,0 +1,23 @@ +package io.github.belgif.rest.problem.spring.boot.client; + +import com.fasterxml.jackson.databind.ObjectMapper; + +import io.github.belgif.rest.problem.spring.ProblemConfigurationProperties; +import io.github.belgif.rest.problem.spring.SpringProblemModule; +import io.github.belgif.rest.problem.spring.SpringProblemTypeRegistry; +import io.github.belgif.rest.problem.spring.client.ProblemResponseJackson2ErrorHandler; + +class ProblemResponseJackson2ErrorHandlerTest extends AbstractProblemResponseErrorHandlerTest { + + ProblemResponseJackson2ErrorHandlerTest() { + super(new ProblemResponseJackson2ErrorHandler(initializeObjectMapper())); + } + + private static ObjectMapper initializeObjectMapper() { + ObjectMapper mapper = new ObjectMapper(); + mapper.registerModule( + new SpringProblemModule(new SpringProblemTypeRegistry(new ProblemConfigurationProperties()))); + return mapper; + } + +} diff --git a/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemResponseJackson3ErrorHandlerTest.java b/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemResponseJackson3ErrorHandlerTest.java new file mode 100644 index 00000000..bb7b7ca5 --- /dev/null +++ b/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/boot/client/ProblemResponseJackson3ErrorHandlerTest.java @@ -0,0 +1,23 @@ +package io.github.belgif.rest.problem.spring.boot.client; + +import io.github.belgif.rest.problem.spring.ProblemConfigurationProperties; +import io.github.belgif.rest.problem.spring.SpringProblemModuleJackson3; +import io.github.belgif.rest.problem.spring.SpringProblemTypeRegistry; +import io.github.belgif.rest.problem.spring.client.ProblemResponseJackson3ErrorHandler; +import tools.jackson.databind.ObjectMapper; +import tools.jackson.databind.json.JsonMapper; + +class ProblemResponseJackson3ErrorHandlerTest extends AbstractProblemResponseErrorHandlerTest { + + ProblemResponseJackson3ErrorHandlerTest() { + super(new ProblemResponseJackson3ErrorHandler(initializeObjectMapper())); + } + + private static ObjectMapper initializeObjectMapper() { + return JsonMapper.builder() + .addModule(new SpringProblemModuleJackson3( + new SpringProblemTypeRegistry(new ProblemConfigurationProperties()))) + .build(); + } + +} diff --git a/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/client/AbstractProblemResponseErrorHandlerTest.java b/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/client/AbstractProblemResponseErrorHandlerTest.java deleted file mode 100644 index 538d2a31..00000000 --- a/belgif-rest-problem-spring/src/test/java/io/github/belgif/rest/problem/spring/client/AbstractProblemResponseErrorHandlerTest.java +++ /dev/null @@ -1,104 +0,0 @@ -package io.github.belgif.rest.problem.spring.client; - -import static org.assertj.core.api.Assertions.*; -import static org.mockito.Mockito.*; - -import java.io.ByteArrayInputStream; -import java.io.InputStream; -import java.net.URI; -import java.nio.charset.StandardCharsets; - -import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.extension.ExtendWith; -import org.mockito.InjectMocks; -import org.mockito.Mock; -import org.mockito.junit.jupiter.MockitoExtension; -import org.springframework.http.HttpMethod; -import org.springframework.http.MediaType; -import org.springframework.mock.http.client.MockClientHttpResponse; -import org.springframework.web.client.HttpClientErrorException; -import org.springframework.web.client.UnknownHttpStatusCodeException; - -import io.github.belgif.rest.problem.BadRequestProblem; -import io.github.belgif.rest.problem.DefaultProblem; -import io.github.belgif.rest.problem.api.Problem; -import io.github.belgif.rest.problem.spring.ProblemMediaType; -import io.github.belgif.rest.problem.spring.client.AbstractProblemResponseErrorHandler.ProblemReader; - -@ExtendWith(MockitoExtension.class) -class AbstractProblemResponseErrorHandlerTest { - - @Mock - private ProblemReader problemReader; - - @InjectMocks - private ProblemResponseErrorHandler handler; - - @Test - void problemMediaType() throws Exception { - InputStream entityStream = new ByteArrayInputStream("dummy".getBytes(StandardCharsets.UTF_8)); - MockClientHttpResponse response = new MockClientHttpResponse(entityStream, 400); - response.getHeaders().setContentType(ProblemMediaType.INSTANCE); - - Problem problem = new BadRequestProblem(); - when(problemReader.read(entityStream)).thenReturn(problem); - assertThatExceptionOfType(BadRequestProblem.class) - .isThrownBy(() -> handler.handleError(URI.create("test"), HttpMethod.GET, response)) - .isEqualTo(problem); - } - - @Test - void jsonMediaTypeErrorStatus() throws Exception { - InputStream entityStream = new ByteArrayInputStream("dummy".getBytes(StandardCharsets.UTF_8)); - MockClientHttpResponse response = new MockClientHttpResponse(entityStream, 400); - response.getHeaders().setContentType(ProblemMediaType.APPLICATION_JSON); - - Problem problem = new BadRequestProblem(); - when(problemReader.read(entityStream)).thenReturn(problem); - assertThatExceptionOfType(BadRequestProblem.class) - .isThrownBy(() -> handler.handleError(URI.create("test"), HttpMethod.GET, response)) - .isEqualTo(problem); - } - - @Test - void jsonMediaTypeNoErrorStatus() { - InputStream entityStream = new ByteArrayInputStream("dummy".getBytes(StandardCharsets.UTF_8)); - MockClientHttpResponse response = new MockClientHttpResponse(entityStream, 200); - response.getHeaders().setContentType(MediaType.APPLICATION_JSON); - - assertThatExceptionOfType(UnknownHttpStatusCodeException.class) - .isThrownBy(() -> handler.handleError(URI.create("test"), HttpMethod.GET, response)); - } - - @Test - void defaultProblem() throws Exception { - InputStream entityStream = new ByteArrayInputStream("dummy".getBytes(StandardCharsets.UTF_8)); - MockClientHttpResponse response = new MockClientHttpResponse(entityStream, 400); - response.getHeaders().setContentType(ProblemMediaType.INSTANCE); - - Problem problem = new DefaultProblem(URI.create("type"), URI.create("href"), "Title", 400); - when(problemReader.read(entityStream)).thenReturn(problem); - assertThatExceptionOfType(DefaultProblem.class) - .isThrownBy(() -> handler.handleError(URI.create("test"), HttpMethod.GET, response)) - .isEqualTo(problem); - } - - @Test - void differentMediaType() { - InputStream entityStream = new ByteArrayInputStream("dummy".getBytes(StandardCharsets.UTF_8)); - MockClientHttpResponse response = new MockClientHttpResponse(entityStream, 400); - response.getHeaders().setContentType(MediaType.APPLICATION_XML); - - assertThatExceptionOfType(HttpClientErrorException.BadRequest.class) - .isThrownBy(() -> handler.handleError(URI.create("test"), HttpMethod.GET, response)); - } - - public static class ProblemResponseErrorHandler extends AbstractProblemResponseErrorHandler { - - ProblemResponseErrorHandler(ProblemReader problemReader) { - super(problemReader); - } - - } - -} diff --git a/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/DefaultProblem.java b/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/DefaultProblem.java index 976a4118..d796f7a1 100644 --- a/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/DefaultProblem.java +++ b/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/DefaultProblem.java @@ -22,8 +22,10 @@ public class DefaultProblem extends Problem implements FluentProblem READ_ONLY_PROPERTIES = new HashSet<>(Arrays.asList("type", "status", "title")); + @JsonProperty(access = JsonProperty.Access.READ_ONLY) private final URI type; private URI href; + @JsonProperty(access = JsonProperty.Access.READ_ONLY) private final String title; + @JsonProperty(access = JsonProperty.Access.READ_ONLY) private final int status; private String detail; private URI instance; diff --git a/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/internal/Jackson2Util.java b/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/internal/Jackson2Util.java index 15e33fd1..16e0c28b 100644 --- a/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/internal/Jackson2Util.java +++ b/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/internal/Jackson2Util.java @@ -5,20 +5,29 @@ import java.util.List; import java.util.regex.Matcher; import java.util.regex.Pattern; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import com.fasterxml.jackson.core.JsonParseException; import com.fasterxml.jackson.databind.JsonMappingException; import com.fasterxml.jackson.databind.JsonMappingException.Reference; +import com.fasterxml.jackson.databind.JsonNode; import io.github.belgif.rest.problem.BadRequestProblem; import io.github.belgif.rest.problem.api.InEnum; import io.github.belgif.rest.problem.api.InputValidationIssues; +import io.github.belgif.rest.problem.api.Problem; /** * Internal jackson 2 utility class. */ public class Jackson2Util { + private static final Logger LOGGER = LoggerFactory.getLogger(Jackson2Util.class); + private static final Pattern VALUE_PATTERN = Pattern.compile("from String \"([^\"]+)\""); private static final Pattern INVALID_FORMAT_PATTERN = @@ -58,6 +67,37 @@ public static BadRequestProblem toBadRequestProblem(JsonMappingException e) { } } + /** + * Check whether the given JsonNode is a Belgif-compliant /health response with status DOWN. + * + * @param payload the response payload + * @return true when health DOWN response, false otherwise + */ + public static boolean isHealthDownResponse(JsonNode payload) { + return payload.has("status") && payload.get("status").isTextual() + && "DOWN".equals(payload.get("status").asText()); + } + + /** + * Check consistency between HTTP status code, status code in JSON payload, and mapped Problem status code. + * + * @param httpStatusCode the HTTP status code + * @param payload the response payload + * @param problem the mapped Problem + * @return true when the provided status codes are consistent, false when inconsistent + */ + public static boolean checkStatusCodeConsistency(Integer httpStatusCode, JsonNode payload, Problem problem) { + Integer payloadStatusCode = + (payload.has("status") && payload.get("status").isInt()) ? payload.get("status").asInt() : null; + Integer problemStatusCode = problem.getStatus(); + if (Stream.of(httpStatusCode, payloadStatusCode, problemStatusCode).collect(Collectors.toSet()).size() > 1) { + LOGGER.warn("Detected inconsistency in problem status code: HTTP={}, JSON={}, Problem={}", + httpStatusCode, payloadStatusCode, problemStatusCode); + return false; + } + return true; + } + private static String getName(List path) { if (path.isEmpty()) { return null; diff --git a/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/internal/Jackson3Util.java b/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/internal/Jackson3Util.java index ca91ef31..ad1d5d15 100644 --- a/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/internal/Jackson3Util.java +++ b/belgif-rest-problem/src/main/java/io/github/belgif/rest/problem/internal/Jackson3Util.java @@ -3,19 +3,28 @@ import static io.github.belgif.rest.problem.api.InputValidationIssues.*; import java.util.List; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; import io.github.belgif.rest.problem.BadRequestProblem; import io.github.belgif.rest.problem.api.InEnum; import io.github.belgif.rest.problem.api.InputValidationIssues; +import io.github.belgif.rest.problem.api.Problem; import tools.jackson.core.JacksonException.Reference; import tools.jackson.core.exc.StreamReadException; import tools.jackson.databind.DatabindException; +import tools.jackson.databind.JsonNode; /** * Internal jackson 3 utility class. */ public class Jackson3Util { + private static final Logger LOGGER = LoggerFactory.getLogger(Jackson3Util.class); + private Jackson3Util() { } @@ -42,6 +51,37 @@ public static BadRequestProblem toBadRequestProblem(DatabindException e) { Jackson2Util.getDetailMessage(e, e.getOriginalMessage()))); } + /** + * Check whether the given JsonNode is a Belgif-compliant /health response with status DOWN. + * + * @param payload the response payload + * @return true when health DOWN response, false otherwise + */ + public static boolean isHealthDownResponse(JsonNode payload) { + return payload.has("status") && payload.get("status").isString() + && "DOWN".equals(payload.get("status").asString()); + } + + /** + * Check consistency between HTTP status code, status code in JSON payload, and mapped Problem status code. + * + * @param httpStatusCode the HTTP status code + * @param payload the response payload + * @param problem the mapped Problem + * @return true when the provided status codes are consistent, false when inconsistent + */ + public static boolean checkStatusCodeConsistency(Integer httpStatusCode, JsonNode payload, Problem problem) { + Integer payloadStatusCode = + (payload.has("status") && payload.get("status").isInt()) ? payload.get("status").asInt() : null; + Integer problemStatusCode = problem.getStatus(); + if (Stream.of(httpStatusCode, payloadStatusCode, problemStatusCode).collect(Collectors.toSet()).size() > 1) { + LOGGER.warn("Detected inconsistency in problem status code: HTTP={}, JSON={}, Problem={}", + httpStatusCode, payloadStatusCode, problemStatusCode); + return false; + } + return true; + } + private static String getName(List path) { if (path.isEmpty()) { return null; diff --git a/belgif-rest-problem/src/test/java/io/github/belgif/rest/problem/internal/Jackson2UtilTest.java b/belgif-rest-problem/src/test/java/io/github/belgif/rest/problem/internal/Jackson2UtilTest.java index 29b06cc6..4a52b767 100644 --- a/belgif-rest-problem/src/test/java/io/github/belgif/rest/problem/internal/Jackson2UtilTest.java +++ b/belgif-rest-problem/src/test/java/io/github/belgif/rest/problem/internal/Jackson2UtilTest.java @@ -17,8 +17,10 @@ import com.fasterxml.jackson.databind.exc.InvalidFormatException; import com.fasterxml.jackson.databind.exc.MismatchedInputException; import com.fasterxml.jackson.databind.exc.ValueInstantiationException; +import com.fasterxml.jackson.databind.node.JsonNodeFactory; import io.github.belgif.rest.problem.BadRequestProblem; +import io.github.belgif.rest.problem.TooManyRequestsProblem; import io.github.belgif.rest.problem.api.InEnum; import io.github.belgif.rest.problem.api.InputValidationIssue; import io.github.belgif.rest.problem.config.ProblemConfig; @@ -185,6 +187,35 @@ void mismatchedInputFormatError() { }); } + @Test + void isHealthDownResponse() { + assertThat(Jackson2Util.isHealthDownResponse(JsonNodeFactory.instance.objectNode())).isFalse(); + assertThat(Jackson2Util.isHealthDownResponse( + JsonNodeFactory.instance.objectNode().put("status", 400))).isFalse(); + assertThat(Jackson2Util.isHealthDownResponse( + JsonNodeFactory.instance.objectNode().put("status", "UP"))).isFalse(); + assertThat(Jackson2Util.isHealthDownResponse( + JsonNodeFactory.instance.objectNode().put("status", "DOWN"))).isTrue(); + } + + @Test + void checkStatusCodeConsistency() { + assertThat(Jackson2Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode().put("status", 400), new BadRequestProblem())).isTrue(); + assertThat(Jackson2Util.checkStatusCodeConsistency(999, + JsonNodeFactory.instance.objectNode().put("status", 400), new BadRequestProblem())).isFalse(); + assertThat(Jackson2Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode().put("status", 999), new BadRequestProblem())).isFalse(); + assertThat(Jackson2Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode().put("status", 400), new TooManyRequestsProblem())).isFalse(); + assertThat(Jackson2Util.checkStatusCodeConsistency(null, + JsonNodeFactory.instance.objectNode().put("status", 400), new BadRequestProblem())).isFalse(); + assertThat(Jackson2Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode(), new BadRequestProblem())).isFalse(); + assertThat(Jackson2Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode().put("status", "DOWN"), new BadRequestProblem())).isFalse(); + } + enum Size { small("S"), medium("M"), large("L"); diff --git a/belgif-rest-problem/src/test/java/io/github/belgif/rest/problem/internal/Jackson3UtilTest.java b/belgif-rest-problem/src/test/java/io/github/belgif/rest/problem/internal/Jackson3UtilTest.java index 26557f04..4aa07e6f 100644 --- a/belgif-rest-problem/src/test/java/io/github/belgif/rest/problem/internal/Jackson3UtilTest.java +++ b/belgif-rest-problem/src/test/java/io/github/belgif/rest/problem/internal/Jackson3UtilTest.java @@ -13,6 +13,7 @@ import com.fasterxml.jackson.annotation.JsonProperty; import io.github.belgif.rest.problem.BadRequestProblem; +import io.github.belgif.rest.problem.TooManyRequestsProblem; import io.github.belgif.rest.problem.api.InEnum; import io.github.belgif.rest.problem.api.InputValidationIssue; import io.github.belgif.rest.problem.config.ProblemConfig; @@ -23,6 +24,7 @@ import tools.jackson.databind.exc.MismatchedInputException; import tools.jackson.databind.exc.ValueInstantiationException; import tools.jackson.databind.json.JsonMapper; +import tools.jackson.databind.node.JsonNodeFactory; class Jackson3UtilTest { @@ -185,6 +187,35 @@ void mismatchedInputFormatError() { }); } + @Test + void isHealthDownResponse() { + assertThat(Jackson3Util.isHealthDownResponse(JsonNodeFactory.instance.objectNode())).isFalse(); + assertThat(Jackson3Util.isHealthDownResponse( + JsonNodeFactory.instance.objectNode().put("status", 400))).isFalse(); + assertThat(Jackson3Util.isHealthDownResponse( + JsonNodeFactory.instance.objectNode().put("status", "UP"))).isFalse(); + assertThat(Jackson3Util.isHealthDownResponse( + JsonNodeFactory.instance.objectNode().put("status", "DOWN"))).isTrue(); + } + + @Test + void checkStatusCodeConsistency() { + assertThat(Jackson3Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode().put("status", 400), new BadRequestProblem())).isTrue(); + assertThat(Jackson3Util.checkStatusCodeConsistency(999, + JsonNodeFactory.instance.objectNode().put("status", 400), new BadRequestProblem())).isFalse(); + assertThat(Jackson3Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode().put("status", 999), new BadRequestProblem())).isFalse(); + assertThat(Jackson3Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode().put("status", 400), new TooManyRequestsProblem())).isFalse(); + assertThat(Jackson3Util.checkStatusCodeConsistency(null, + JsonNodeFactory.instance.objectNode().put("status", 400), new BadRequestProblem())).isFalse(); + assertThat(Jackson3Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode(), new BadRequestProblem())).isFalse(); + assertThat(Jackson3Util.checkStatusCodeConsistency(400, + JsonNodeFactory.instance.objectNode().put("status", "DOWN"), new BadRequestProblem())).isFalse(); + } + enum Size { small("S"), medium("M"), large("L"); diff --git a/pom.xml b/pom.xml index 76dbdace..93e7f64b 100644 --- a/pom.xml +++ b/pom.xml @@ -16,7 +16,7 @@ latest - 8 + 11 true UTF-8 diff --git a/src/main/asciidoc/release-notes.adoc b/src/main/asciidoc/release-notes.adoc index 61fce587..fabb8a4f 100644 --- a/src/main/asciidoc/release-notes.adoc +++ b/src/main/asciidoc/release-notes.adoc @@ -12,6 +12,25 @@ // tag::recent-versions[] +== Version 0.24 + +[WARNING] +==== +*Breaking change:* Core, Java EE, Jakarta EE and Quarkus modules now require *JDK11+* (previously JDK8+). +==== + +*belgif-rest-problem*: + +* Don't treat https://www.belgif.be/specification/rest/api-guide/health.html[Belgif health] HTTP 503 `{ "status": "DOWN" }` as a problem response: +** For JAX-RS, the health response is returned AS-IS +** For MicroProfile REST Client, a HTTP 503 WebApplicationException is thrown, which can be caught to access the health response +** For Spring RestTemplate / RestClient, the health response is returned AS-IS +** For Spring WebClient, a WebClientResponseException.ServiceUnavailable is thrown, which can be caught to access the health response +* Log a warning when a status code inconsistency is detected in a problem response. +This evaluates the HTTP status code against the JSON body status code and against the static status code associated with the corresponding problem type: + + WARNING Detected inconsistency in problem status code: HTTP=404, JSON=400, Problem=404 + == Version 0.23 *belgif-rest-problem*: