Add entrypoint to setup a configurator for Spring Restate services. (#548)

Author: slinkydeveloper

sdk-spring-boot-starter/src/test/java/dev/restate/sdk/springboot/java/Configuration.java

@@ -0,0 +1,19 @@
+// Copyright (c) 2023 - Restate Software, Inc., Restate GmbH
+//
+// This file is part of the Restate Java SDK,
+// which is released under the MIT license.
+//
+// You can find a copy of the license in file LICENSE in the root
+// directory of this repository or package, or at
+// https://github.com/restatedev/sdk-java/blob/main/LICENSE
+package dev.restate.sdk.springboot.java;
+
+import dev.restate.sdk.springboot.RestateServiceConfigurator;
+import org.springframework.context.annotation.Bean;
+
+public class Configuration {
+  @Bean
+  public RestateServiceConfigurator greeterConfiguration() {
+    return configurator -> configurator.documentation("blabla");
+  }
+}

sdk-spring-boot-starter/src/test/java/dev/restate/sdk/springboot/java/Greeter.java

@@ -14,7 +14,7 @@
 import dev.restate.sdk.springboot.RestateService;
 import org.springframework.beans.factory.annotation.Value;
 
-@RestateService
+@RestateService(configuration = "greeterConfiguration")
 @Name("greeter")
 public class Greeter {
 

sdk-spring-boot-starter/src/test/java/dev/restate/sdk/springboot/java/RestateHttpEndpointBeanTest.java

@@ -8,7 +8,7 @@
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
 package dev.restate.sdk.springboot.java;
 
-import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.Assertions.*;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import dev.restate.sdk.core.generated.manifest.EndpointManifestSchema;
@@ -23,7 +23,7 @@
 import org.springframework.boot.test.context.SpringBootTest;
 
 @SpringBootTest(
-    classes = {RestateHttpEndpointBean.class, Greeter.class},
+    classes = {RestateHttpEndpointBean.class, Greeter.class, Configuration.class},
     properties = {"restate.sdk.http.port=0"})
 public class RestateHttpEndpointBeanTest {
 
@@ -44,7 +44,7 @@ public void httpEndpointShouldBeRunning() throws IOException, InterruptedExcepti
                 .uri(
                     URI.create(
                         "http://localhost:" + restateHttpEndpointBean.actualPort() + "/discover"))
-                .header("Accept", "application/vnd.restate.endpointmanifest.v1+json")
+                .header("Accept", "application/vnd.restate.endpointmanifest.v4+json")
                 .build(),
             HttpResponse.BodyHandlers.ofString());
     assertThat(response.version()).isEqualTo(HttpClient.Version.HTTP_2);
@@ -54,7 +54,9 @@ public void httpEndpointShouldBeRunning() throws IOException, InterruptedExcepti
         new ObjectMapper().readValue(response.body(), EndpointManifestSchema.class);
 
     assertThat(endpointManifest.getServices())
-        .map(dev.restate.sdk.core.generated.manifest.Service::getName)
-        .containsOnly("greeter");
+        .extracting(
+            dev.restate.sdk.core.generated.manifest.Service::getName,
+            dev.restate.sdk.core.generated.manifest.Service::getDocumentation)
+        .containsOnly(tuple("greeter", "blabla"));
   }
 }

sdk-spring-boot/src/main/java/dev/restate/sdk/springboot/RestateComponent.java

@@ -23,4 +23,10 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 @Component
-public @interface RestateComponent {}
+public @interface RestateComponent {
+  /**
+   * Bean name to use to configure this component. The bean MUST be an instance of {@link
+   * RestateServiceConfigurator}.
+   */
+  String configuration() default "";
+}

sdk-spring-boot/src/main/java/dev/restate/sdk/springboot/RestateHttpEndpointBean.java

@@ -62,8 +62,17 @@ public void afterPropertiesSet() {
     }
 
     var builder = Endpoint.builder();
-    for (Object component : restateComponents.values()) {
-      builder = builder.bind(component);
+    for (var componentEntry : restateComponents.entrySet()) {
+      // Get configurator, if any
+      RestateComponent restateComponent =
+          applicationContext.findAnnotationOnBean(componentEntry.getKey(), RestateComponent.class);
+      RestateServiceConfigurator configurator = c -> {};
+      if (restateComponent != null && !restateComponent.configuration().isEmpty()) {
+        configurator =
+            applicationContext.getBean(
+                restateComponent.configuration(), RestateServiceConfigurator.class);
+      }
+      builder = builder.bind(componentEntry.getValue(), configurator);
     }
 
     if (restateEndpointProperties.isEnablePreviewContext()) {

sdk-spring-boot/src/main/java/dev/restate/sdk/springboot/RestateService.java

@@ -13,6 +13,7 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import org.springframework.core.annotation.AliasFor;
 
 /**
  * Proxy annotation for {@link Service}, to avoid naming clashes with Spring's built in annotations
@@ -23,4 +24,12 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Service
 @RestateComponent
-public @interface RestateService {}
+public @interface RestateService {
+
+  /**
+   * Bean name to use to configure this service. The bean MUST be an instance of {@link
+   * RestateServiceConfigurator}.
+   */
+  @AliasFor(annotation = RestateComponent.class, attribute = "configuration")
+  String configuration() default "";
+}

sdk-spring-boot/src/main/java/dev/restate/sdk/springboot/RestateServiceConfigurator.java

@@ -0,0 +1,16 @@
+// Copyright (c) 2023 - Restate Software, Inc., Restate GmbH
+//
+// This file is part of the Restate Java SDK,
+// which is released under the MIT license.
+//
+// You can find a copy of the license in file LICENSE in the root
+// directory of this repository or package, or at
+// https://github.com/restatedev/sdk-java/blob/main/LICENSE
+package dev.restate.sdk.springboot;
+
+import dev.restate.sdk.endpoint.definition.ServiceDefinition;
+import java.util.function.Consumer;
+
+/** Service configurator to be registered as */
+@FunctionalInterface
+public interface RestateServiceConfigurator extends Consumer<ServiceDefinition.Configurator> {}

sdk-spring-boot/src/main/java/dev/restate/sdk/springboot/RestateVirtualObject.java

@@ -14,6 +14,7 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import org.springframework.core.annotation.AliasFor;
 
 /**
  * Proxy annotation for {@link VirtualObject}.
@@ -24,4 +25,12 @@
 @Retention(RetentionPolicy.RUNTIME)
 @VirtualObject
 @RestateComponent
-public @interface RestateVirtualObject {}
+public @interface RestateVirtualObject {
+
+  /**
+   * Bean name to use to configure this virtual object. The bean MUST be an instance of {@link
+   * RestateServiceConfigurator}.
+   */
+  @AliasFor(annotation = RestateComponent.class, attribute = "configuration")
+  String configuration() default "";
+}

sdk-spring-boot/src/main/java/dev/restate/sdk/springboot/RestateWorkflow.java

@@ -14,6 +14,7 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import org.springframework.core.annotation.AliasFor;
 
 /**
  * Proxy annotation for {@link Workflow}.
@@ -24,4 +25,12 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Workflow
 @RestateComponent
-public @interface RestateWorkflow {}
+public @interface RestateWorkflow {
+
+  /**
+   * Bean name to use to configure this workflow. The bean MUST be an instance of {@link
+   * RestateServiceConfigurator}.
+   */
+  @AliasFor(annotation = RestateComponent.class, attribute = "configuration")
+  String configuration() default "";
+}