feat(springboot openfeign): An OpenFeign Client for Dapr Invokes

A OpenFeign Client and it's AutoConfiguration using Dapr Invoke APIs.

Splited into two librarys, dapr-openfeign-client is the pure client of OpenFeign, and dapr-spring-openfeign is the plugin of Spring Cloud OpenFeign.

Currently only HTTP Invoke Method and Invoke Binding supported, and Invoke Binding is not always recommend to use this client, depends on what binding component is.

Signed-off-by: lony2003 <zhangke200377@outlook.com>

Author: lony2003

dapr-spring/dapr-openfeign-client/src/main/java/io/dapr/feign/DaprInvokeFeignClient.java

@@ -332,18 +332,23 @@ private Map<String, String> toHeader(Map<String, Collection<String>> header) {
   }
 
   private Response.Body toResponseBody(Mono<byte[]> response, Request.Options options) throws IOException {
-    byte[] result;
+    byte[] result = new byte[0];
 
-    try {
-      result = response.retry(retry).block(Duration.of(timeout,
-          TimeUnit.MILLISECONDS.toChronoUnit()));
+    for (int count = 0; count < retry; count++) {
+      try {
+        result = response.block(Duration.of(timeout,
+            TimeUnit.MILLISECONDS.toChronoUnit()));
 
-      if (result == null) {
-        result = new byte[0];
-      }
+        if (result == null) {
+          result = new byte[0];
+        }
 
-    } catch (RuntimeException e) {
-      throw new IOException("Can not get Response", e);
+        break;
+      } catch (RuntimeException e) {
+        if (retry == count + 1) {
+          throw new IOException("Can not get Response", e);
+        }
+      }
     }
 
 

sdk-tests/src/test/java/io/dapr/it/spring/feign/DaprFeignIT.java

@@ -1,8 +1,13 @@
 package io.dapr.it.spring.feign;
 
+import io.dapr.client.DaprClient;
+import io.dapr.client.domain.HttpExtension;
 import io.dapr.testcontainers.Component;
 import io.dapr.testcontainers.DaprContainer;
 import io.dapr.testcontainers.DaprLogLevel;
+import io.dapr.utils.TypeRef;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Tag;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
@@ -12,18 +17,29 @@
 import org.springframework.test.context.junit.jupiter.SpringExtension;
 import org.testcontainers.containers.Network;
 import org.testcontainers.containers.PostgreSQLContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
 import org.testcontainers.junit.jupiter.Container;
 import org.testcontainers.junit.jupiter.Testcontainers;
 
+import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
 import static io.dapr.it.spring.data.DaprSpringDataConstants.STATE_STORE_NAME;
 import static io.dapr.it.testcontainers.DaprContainerConstants.IMAGE_TAG;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
-@ExtendWith(SpringExtension.class)
-@SpringBootTest(properties = {"dapr.feign.enable=true"})
+@SpringBootTest(
+    webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT,
+    classes = {
+      DaprFeignTestApplication.class
+    },
+    properties = {
+        "dapr.feign.enabled=true",
+        "dapr.feign.retries=1"
+    }
+)
 @Testcontainers
 @Tag("testcontainers")
 public class DaprFeignIT {
@@ -36,6 +52,9 @@ public class DaprFeignIT {
 
   public static final String BINDING_NAME = "postgresbinding";
 
+  private static final int APP_PORT = 8080;
+  private static final String SUBSCRIPTION_MESSAGE_PATTERN = ".*app is subscribed to the following topics.*";
+
   @Container
   private static final PostgreSQLContainer<?> POSTGRE_SQL_CONTAINER = new PostgreSQLContainer<>("postgres:16-alpine")
       .withNetworkAliases("postgres-repository")
@@ -49,11 +68,26 @@ public class DaprFeignIT {
   private static final DaprContainer DAPR_CONTAINER = new DaprContainer(IMAGE_TAG)
       .withAppName("dapr-feign-test")
       .withNetwork(DAPR_NETWORK)
+      .withComponent(new Component("pubsub", "pubsub.in-memory", "v1", Collections.emptyMap()))
       .withComponent(new Component(BINDING_NAME, "bindings.postgresql", "v1", BINDING_PROPERTIES))
       .withDaprLogLevel(DaprLogLevel.DEBUG)
+      .withAppPort(APP_PORT)
+      .withAppHealthCheckPath("/ready")
+      .withAppChannelAddress("host.testcontainers.internal")
       .withLogConsumer(outputFrame -> System.out.println(outputFrame.getUtf8String()))
       .dependsOn(POSTGRE_SQL_CONTAINER);
 
+  @BeforeAll
+  public static void beforeAll(){
+    org.testcontainers.Testcontainers.exposeHostPorts(APP_PORT);
+  }
+
+  @BeforeEach
+  public void beforeEach() {
+    // Ensure the subscriptions are registered
+    Wait.forLogMessage(SUBSCRIPTION_MESSAGE_PATTERN, 1).waitUntilReady(DAPR_CONTAINER);
+  }
+
   @Autowired
   PostgreBindingClient postgreBindingClient;
 
@@ -66,9 +100,18 @@ public void invokeBindingTest() {
   }
 
   @Test
-  public void invokeMethodTest() {
+  public void invokeSimpleGetMethodTest() {
     assertEquals("hello", testMethodClient.hello());
+  }
+
+  @Test
+  public void invokeSimplePostMethodTest() {
     assertEquals("hello", testMethodClient.echo("hello"));
   }
 
+  @Test
+  public void invokeJsonMethodTest() {
+    assertEquals("hello", testMethodClient.echoJson("hello").getMessage());
+  }
+
 }

sdk-tests/src/test/java/io/dapr/it/spring/feign/Result.java

@@ -1,12 +1,18 @@
 package io.dapr.it.spring.feign;
 
 public class Result {
-  private final String message;
+  private String message;
+
+  public Result() {}
 
   public Result(String message) {
     this.message = message;
   }
 
+  public void setMessage(String message) {
+    this.message = message;
+  }
+
   public String getMessage() {
     return message;
   }

sdk-tests/src/test/java/io/dapr/it/spring/feign/TestMethodClient.java

@@ -1,5 +1,6 @@
 package io.dapr.it.spring.feign;
 
+import io.dapr.Topic;
 import io.dapr.spring.openfeign.annotation.UseDaprClient;
 import org.springframework.cloud.openfeign.FeignClient;
 import org.springframework.web.bind.annotation.GetMapping;
@@ -10,13 +11,13 @@
 @UseDaprClient
 public interface TestMethodClient {
 
-  @GetMapping("/hello")
+  @GetMapping(value = "/hello")
   String hello();
 
   @PostMapping("/echo")
   String echo(@RequestBody String input);
 
-  @PostMapping(value = "/echoj", consumes = "text/plain", produces = "application/json")
+  @PostMapping(value = "/echoj", produces = "application/json;charset=utf-8")
   Result echoJson(@RequestBody String input);
 
 }

sdk-tests/src/test/java/io/dapr/it/spring/feign/TestRestController.java

@@ -1,5 +1,6 @@
 package io.dapr.it.spring.feign;
 
+import io.dapr.Topic;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
@@ -8,11 +9,20 @@
 @RestController
 public class TestRestController {
 
+  public static final String pubSubName = "pubsub";
+  public static final String topicName = "mockTopic";
+
+  @GetMapping("/ready")
+  public String ok() {
+    return "OK";
+  }
+
   @GetMapping("/hello")
   public String hello() {
     return "hello";
   }
 
+  @Topic(name = topicName, pubsubName = pubSubName)
   @PostMapping("/echo")
   public String echo(@RequestBody String input) {
     return input;