Fix ProblemWebClientCustomizer Spring Boot compatibility issue (#102)

jpraet · smals-mavh · web-flow · commit cdc1fcdd2563 · 2024-09-24T11:33:32.000+02:00
Fixes #98. Extract class from belgif-rest-problem-spring to belgif-rest-problem-spring-boot-2 and -3. --------- Co-authored-by: Marcel Van Hassel <marcel.vanhassel@smals.be>
diff --git a/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/AbstractRestProblemIT.java b/belgif-rest-problem-it/belgif-rest-problem-it-common/src/main/java/io/github/belgif/rest/problem/AbstractRestProblemIT.java
@@ -59,6 +59,15 @@ void retryAfter() {
                 .body("type", equalTo("urn:problem-type:belgif:serviceUnavailable"));
     }
 
+    @ParameterizedTest
+    @MethodSource("getClients")
+    void okFromBackend(String client) {
+        getSpec().when().queryParam("client", client)
+                .get("/okFromBackend").then().assertThat()
+                .statusCode(200)
+                .body(containsString("OK"));
+    }
+
     @ParameterizedTest
     @MethodSource("getClients")
     void badRequestFromBackend(String client) {
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
@@ -7,6 +7,10 @@
 @Path("/backend")
 public interface Backend {
 
+    @GET
+    @Path("/ok")
+    Response ok();
+
     @GET
     @Path("/badRequest")
     Response badRequest();
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
@@ -12,6 +12,11 @@
 @RequestScoped
 public class BackendImpl implements Backend {
 
+    @Override
+    public Response ok() {
+        return Response.ok("OK").build();
+    }
+
     @Override
     public Response badRequest() {
         BadRequestProblem problem = new BadRequestProblem();
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
@@ -4,7 +4,12 @@
 import jakarta.validation.constraints.NotNull;
 import jakarta.validation.constraints.Positive;
 import jakarta.validation.constraints.Size;
-import jakarta.ws.rs.*;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.HeaderParam;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.QueryParam;
 import jakarta.ws.rs.core.Response;
 
 import io.github.belgif.rest.problem.model.ChildModel;
@@ -33,6 +38,10 @@ public interface Frontend {
     @Path("/retryAfter")
     Response retryAfter();
 
+    @GET
+    @Path("/okFromBackend")
+    Response okFromBackend(@QueryParam("client") Client client);
+
     @GET
     @Path("/badRequestFromBackend")
     Response badRequestFromBackend(@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
@@ -80,6 +80,31 @@ public Response retryAfter() {
         throw problem;
     }
 
+    @Override
+    public Response okFromBackend(Client client) {
+        String result = null;
+        if (client == null || client == Client.MICROPROFILE) {
+            result = microprofileClient.ok().readEntity(String.class);
+        } else if (client == Client.JAXRS) {
+            result = jaxRsClient.target(BASE_URI).path("backend/ok").request().get().readEntity(String.class);
+        } else if (client == Client.JAXRS_ASYNC) {
+            try {
+                result = jaxRsClient.target(BASE_URI).path("backend/ok").request().async().get().get()
+                        .readEntity(String.class);
+            } catch (InterruptedException e) {
+                Thread.currentThread().interrupt();
+                throw new RuntimeException(e);
+            } catch (ExecutionException e) {
+                throw new RuntimeException(e);
+            }
+        } else if (client == Client.RESTEASY) {
+            result = resteasyClient.target(BASE_URI).path("backend/ok").request().get().readEntity(String.class);
+        } else if (client == Client.RESTEASY_PROXY) {
+            result = resteasyProxyClient.ok().readEntity(String.class);
+        }
+        return Response.ok(result).build();
+    }
+
     @Override
     public Response badRequestFromBackend(Client client) {
         try {
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
@@ -7,6 +7,10 @@
 @Path("/backend")
 public interface Backend {
 
+    @GET
+    @Path("/ok")
+    Response ok();
+
     @GET
     @Path("/badRequest")
     Response badRequest();
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
@@ -12,6 +12,11 @@
 @RequestScoped
 public class BackendImpl implements Backend {
 
+    @Override
+    public Response ok() {
+        return Response.ok("OK").build();
+    }
+
     @Override
     public Response badRequest() {
         BadRequestProblem problem = new BadRequestProblem();
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
@@ -4,7 +4,12 @@
 import javax.validation.constraints.NotNull;
 import javax.validation.constraints.Positive;
 import javax.validation.constraints.Size;
-import javax.ws.rs.*;
+import javax.ws.rs.GET;
+import javax.ws.rs.HeaderParam;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.Response;
 
 import io.github.belgif.rest.problem.model.ChildModel;
@@ -33,6 +38,10 @@ public interface Frontend {
     @Path("/retryAfter")
     Response retryAfter();
 
+    @GET
+    @Path("/okFromBackend")
+    Response okFromBackend(@QueryParam("client") Client client);
+
     @GET
     @Path("/badRequestFromBackend")
     Response badRequestFromBackend(@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
@@ -79,6 +79,31 @@ public Response retryAfter() {
         throw problem;
     }
 
+    @Override
+    public Response okFromBackend(Client client) {
+        String result = null;
+        if (client == null || client == Client.MICROPROFILE) {
+            result = microprofileClient.ok().readEntity(String.class);
+        } else if (client == Client.JAXRS) {
+            result = jaxRsClient.target(BASE_URI).path("backend/ok").request().get().readEntity(String.class);
+        } else if (client == Client.JAXRS_ASYNC) {
+            try {
+                result = jaxRsClient.target(BASE_URI).path("backend/ok").request().async().get().get()
+                        .readEntity(String.class);
+            } catch (InterruptedException e) {
+                Thread.currentThread().interrupt();
+                throw new RuntimeException(e);
+            } catch (ExecutionException e) {
+                throw new RuntimeException(e);
+            }
+        } else if (client == Client.RESTEASY) {
+            result = resteasyClient.target(BASE_URI).path("backend/ok").request().get().readEntity(String.class);
+        } else if (client == Client.RESTEASY_PROXY) {
+            result = resteasyProxyClient.ok().readEntity(String.class);
+        }
+        return Response.ok(result).build();
+    }
+
     @Override
     public Response badRequestFromBackend(Client client) {
         try {
diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-2-it/src/main/java/io/github/belgif/rest/problem/BackendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-2-it/src/main/java/io/github/belgif/rest/problem/BackendController.java
@@ -2,6 +2,7 @@
 
 import java.net.URI;
 
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -14,6 +15,11 @@
 @RequestMapping("/backend")
 public class BackendController {
 
+    @GetMapping("/ok")
+    public ResponseEntity<String> ok() {
+        return ResponseEntity.ok("OK");
+    }
+
     @GetMapping("/badRequest")
     public void badRequest() {
         BadRequestProblem problem = new BadRequestProblem();
diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-2-it/src/main/java/io/github/belgif/rest/problem/FrontendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-2-it/src/main/java/io/github/belgif/rest/problem/FrontendController.java
@@ -3,14 +3,23 @@
 import java.net.URI;
 
 import javax.validation.Valid;
-import javax.validation.constraints.*;
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Positive;
+import javax.validation.constraints.Size;
 
 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.ResponseEntity;
 import org.springframework.validation.annotation.Validated;
-import org.springframework.web.bind.annotation.*;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.reactive.function.client.WebClient;
 
@@ -83,6 +92,17 @@ public void retryAfter() {
         throw problem;
     }
 
+    @GetMapping("/okFromBackend")
+    public ResponseEntity<String> okFromBackend(@RequestParam("client") Client client) {
+        String result = null;
+        if (client == Client.REST_TEMPLATE) {
+            result = restTemplate.getForObject("/ok", String.class);
+        } else if (client == Client.WEB_CLIENT) {
+            result = webClient.get().uri("/ok").retrieve().toEntity(String.class).block().getBody();
+        }
+        return ResponseEntity.ok(result);
+    }
+
     @GetMapping("/badRequestFromBackend")
     public void badRequestFromBackend(@RequestParam("client") Client client) {
         try {
diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/BackendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/BackendController.java
@@ -2,6 +2,7 @@
 
 import java.net.URI;
 
+import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -14,6 +15,11 @@
 @RequestMapping("/backend")
 public class BackendController {
 
+    @GetMapping("/ok")
+    public ResponseEntity<String> ok() {
+        return ResponseEntity.ok("OK");
+    }
+
     @GetMapping("/badRequest")
     public void badRequest() {
         BadRequestProblem problem = new BadRequestProblem();
diff --git a/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/FrontendController.java b/belgif-rest-problem-it/belgif-rest-problem-spring-boot-3-it/src/main/java/io/github/belgif/rest/problem/FrontendController.java
@@ -3,14 +3,23 @@
 import java.net.URI;
 
 import jakarta.validation.Valid;
-import jakarta.validation.constraints.*;
+import jakarta.validation.constraints.NotNull;
+import jakarta.validation.constraints.Positive;
+import jakarta.validation.constraints.Size;
 
 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.ResponseEntity;
 import org.springframework.validation.annotation.Validated;
-import org.springframework.web.bind.annotation.*;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestHeader;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.client.RestClient;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.reactive.function.client.WebClient;
@@ -95,6 +104,19 @@ public void retryAfter() {
         throw problem;
     }
 
+    @GetMapping("/okFromBackend")
+    public ResponseEntity<String> okFromBackend(@RequestParam("client") Client client) {
+        String result = null;
+        if (client == Client.REST_TEMPLATE) {
+            result = restTemplate.getForObject("/ok", String.class);
+        } else if (client == Client.WEB_CLIENT) {
+            result = webClient.get().uri("/ok").retrieve().toEntity(String.class).block().getBody();
+        } else if (client == Client.REST_CLIENT) {
+            result = restClient.get().uri("/ok").retrieve().toEntity(String.class).getBody();
+        }
+        return ResponseEntity.ok(result);
+    }
+
     @GetMapping("/badRequestFromBackend")
     public void badRequestFromBackend(@RequestParam("client") Client client) {
         try {
diff --git a/belgif-rest-problem-spring-boot-2/pom.xml b/belgif-rest-problem-spring-boot-2/pom.xml
@@ -30,6 +30,47 @@
       <artifactId>belgif-rest-problem-spring</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-autoconfigure</artifactId>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-web</artifactId>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-webmvc</artifactId>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-webflux</artifactId>
+      <scope>provided</scope>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.assertj</groupId>
+      <artifactId>assertj-core</artifactId>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
 </project>
diff --git a/belgif-rest-problem-spring-boot-2/src/main/java/io/github/belgif/rest/problem/spring/ProblemWebClientCustomizer.java b/belgif-rest-problem-spring-boot-2/src/main/java/io/github/belgif/rest/problem/spring/ProblemWebClientCustomizer.java
@@ -12,6 +12,9 @@
 
 /**
  * WebClientCustomizer that registers a filter that converts problem responses to Problem exceptions.
+ *
+ * NOTE: This class is intentionally duplicated in belgif-rest-problem-spring-boot-3,
+ * to address a (<a href="https://github.com/belgif/rest-problem-java/issues/98">compatibility issue</a>).
  */
 @Component
 @ConditionalOnClass(WebClient.class)
diff --git a/belgif-rest-problem-spring-boot-2/src/test/java/io/github/belgif/rest/problem/spring/ProblemWebClientCustomizerTest.java b/belgif-rest-problem-spring-boot-2/src/test/java/io/github/belgif/rest/problem/spring/ProblemWebClientCustomizerTest.java
diff --git a/belgif-rest-problem-spring-boot-3/pom.xml b/belgif-rest-problem-spring-boot-3/pom.xml
@@ -46,6 +46,12 @@
       <artifactId>spring-webmvc</artifactId>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-webflux</artifactId>
+      <scope>provided</scope>
+      <optional>true</optional>
+    </dependency>
     <dependency>
       <groupId>com.fasterxml.jackson.core</groupId>
       <artifactId>jackson-databind</artifactId>
diff --git a/belgif-rest-problem-spring-boot-3/src/main/java/io/github/belgif/rest/problem/spring/ProblemWebClientCustomizer.java b/belgif-rest-problem-spring-boot-3/src/main/java/io/github/belgif/rest/problem/spring/ProblemWebClientCustomizer.java
diff --git a/belgif-rest-problem-spring-boot-3/src/test/java/io/github/belgif/rest/problem/spring/ProblemWebClientCustomizerTest.java b/belgif-rest-problem-spring-boot-3/src/test/java/io/github/belgif/rest/problem/spring/ProblemWebClientCustomizerTest.java
diff --git a/src/main/asciidoc/index.adoc b/src/main/asciidoc/index.adoc
