ScheduleClient for SpringBoot (#1816)

* ScheduleClient for SpringBoot

Signed-off-by: Tihomir Surdilovic <[email protected]>

* Update temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/RootNamespaceAutoConfiguration.java

Co-authored-by: Chad Retz <[email protected]>

* create schedule client from template

Signed-off-by: Tihomir Surdilovic <[email protected]>

---------

Signed-off-by: Tihomir Surdilovic <[email protected]>
Co-authored-by: Chad Retz <[email protected]>

Author: tsurdilo

temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/RootNamespaceAutoConfiguration.java

@@ -23,6 +23,8 @@
 import io.opentracing.Tracer;
 import io.temporal.client.WorkflowClient;
 import io.temporal.client.WorkflowClientOptions;
+import io.temporal.client.schedules.ScheduleClient;
+import io.temporal.client.schedules.ScheduleClientOptions;
 import io.temporal.common.converter.DataConverter;
 import io.temporal.serviceclient.WorkflowServiceStubs;
 import io.temporal.spring.boot.TemporalOptionsCustomizer;
@@ -86,7 +88,9 @@ public NamespaceTemplate rootNamespaceTemplate(
       @Autowired(required = false) @Nullable
           TemporalOptionsCustomizer<WorkerOptions.Builder> workerCustomizer,
       @Autowired(required = false) @Nullable
-          TemporalOptionsCustomizer<WorkflowClientOptions.Builder> clientCustomizer) {
+          TemporalOptionsCustomizer<WorkflowClientOptions.Builder> clientCustomizer,
+      @Autowired(required = false) @Nullable
+          TemporalOptionsCustomizer<ScheduleClientOptions.Builder> scheduleCustomize) {
     DataConverter chosenDataConverter =
         AutoConfigurationUtils.choseDataConverter(dataConverters, mainDataConverter);
     return new NamespaceTemplate(
@@ -98,7 +102,8 @@ public NamespaceTemplate rootNamespaceTemplate(
         testWorkflowEnvironment,
         workerFactoryCustomizer,
         workerCustomizer,
-        clientCustomizer);
+        clientCustomizer,
+        scheduleCustomize);
   }
 
   /** Client */
@@ -113,6 +118,11 @@ public WorkflowClient client(ClientTemplate clientTemplate) {
     return clientTemplate.getWorkflowClient();
   }
 
+  @Bean(name = "temporalScheduleClient")
+  public ScheduleClient scheduleClient(ClientTemplate clientTemplate) {
+    return clientTemplate.getScheduleClient();
+  }
+
   /** Workers */
   @Bean(name = "temporalWorkersTemplate")
   @Conditional(WorkersPresentCondition.class)

temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/TestServerAutoConfiguration.java

@@ -23,6 +23,7 @@
 import com.uber.m3.tally.Scope;
 import io.opentracing.Tracer;
 import io.temporal.client.WorkflowClientOptions;
+import io.temporal.client.schedules.ScheduleClientOptions;
 import io.temporal.common.converter.DataConverter;
 import io.temporal.serviceclient.WorkflowServiceStubsOptions;
 import io.temporal.spring.boot.TemporalOptionsCustomizer;
@@ -79,6 +80,8 @@ public TestWorkflowEnvironment testWorkflowEnvironment(
           TemporalOptionsCustomizer<WorkerFactoryOptions.Builder> workerFactoryCustomizer,
       @Autowired(required = false) @Nullable
           TemporalOptionsCustomizer<WorkflowClientOptions.Builder> clientCustomizer,
+      @Autowired(required = false) @Nullable
+          TemporalOptionsCustomizer<ScheduleClientOptions.Builder> scheduleCustomizer,
       @Autowired(required = false) @Nullable
           TemporalOptionsCustomizer<WorkflowServiceStubsOptions.Builder>
               workflowServiceStubsCustomizer) {
@@ -94,7 +97,11 @@ public TestWorkflowEnvironment testWorkflowEnvironment(
         TestEnvironmentOptions.newBuilder()
             .setWorkflowClientOptions(
                 new WorkflowClientOptionsTemplate(
-                        properties.getNamespace(), chosenDataConverter, otTracer, clientCustomizer)
+                        properties.getNamespace(),
+                        chosenDataConverter,
+                        otTracer,
+                        clientCustomizer,
+                        scheduleCustomizer)
                     .createWorkflowClientOptions());
 
     if (metricsScope != null) {

temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/ClientTemplate.java

@@ -24,6 +24,8 @@
 import io.opentracing.Tracer;
 import io.temporal.client.WorkflowClient;
 import io.temporal.client.WorkflowClientOptions;
+import io.temporal.client.schedules.ScheduleClient;
+import io.temporal.client.schedules.ScheduleClientOptions;
 import io.temporal.common.converter.DataConverter;
 import io.temporal.serviceclient.WorkflowServiceStubs;
 import io.temporal.spring.boot.TemporalOptionsCustomizer;
@@ -37,16 +39,19 @@ public class ClientTemplate {
   private final @Nullable TestWorkflowEnvironmentAdapter testWorkflowEnvironment;
 
   private WorkflowClient workflowClient;
+  private ScheduleClient scheduleClient;
 
   public ClientTemplate(
       @Nonnull String namespace,
       @Nullable DataConverter dataConverter,
       @Nullable Tracer tracer,
       @Nullable WorkflowServiceStubs workflowServiceStubs,
       @Nullable TestWorkflowEnvironmentAdapter testWorkflowEnvironment,
-      @Nullable TemporalOptionsCustomizer<WorkflowClientOptions.Builder> customizer) {
+      @Nullable TemporalOptionsCustomizer<WorkflowClientOptions.Builder> clientCustomizer,
+      @Nullable TemporalOptionsCustomizer<ScheduleClientOptions.Builder> scheduleCustomer) {
     this.optionsTemplate =
-        new WorkflowClientOptionsTemplate(namespace, dataConverter, tracer, customizer);
+        new WorkflowClientOptionsTemplate(
+            namespace, dataConverter, tracer, clientCustomizer, scheduleCustomer);
     this.workflowServiceStubs = workflowServiceStubs;
     this.testWorkflowEnvironment = testWorkflowEnvironment;
   }
@@ -58,6 +63,13 @@ public WorkflowClient getWorkflowClient() {
     return workflowClient;
   }
 
+  public ScheduleClient getScheduleClient() {
+    if (scheduleClient == null) {
+      this.scheduleClient = createScheduleClient();
+    }
+    return scheduleClient;
+  }
+
   private WorkflowClient createWorkflowClient() {
     if (testWorkflowEnvironment != null) {
       return testWorkflowEnvironment.getWorkflowClient();
@@ -68,4 +80,16 @@ private WorkflowClient createWorkflowClient() {
           workflowServiceStubs, optionsTemplate.createWorkflowClientOptions());
     }
   }
+
+  private ScheduleClient createScheduleClient() {
+    if (testWorkflowEnvironment != null) {
+      return ScheduleClient.newInstance(
+          testWorkflowEnvironment.getWorkflowClient().getWorkflowServiceStubs());
+    } else {
+      Preconditions.checkState(
+          workflowServiceStubs != null, "ClientTemplate was created without workflowServiceStubs");
+      return ScheduleClient.newInstance(
+          workflowServiceStubs, optionsTemplate.createScheduleClientOptions());
+    }
+  }
 }

temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/NamespaceTemplate.java

@@ -22,6 +22,7 @@
 
 import io.opentracing.Tracer;
 import io.temporal.client.WorkflowClientOptions;
+import io.temporal.client.schedules.ScheduleClientOptions;
 import io.temporal.common.converter.DataConverter;
 import io.temporal.serviceclient.WorkflowServiceStubs;
 import io.temporal.spring.boot.TemporalOptionsCustomizer;
@@ -44,6 +45,8 @@ public class NamespaceTemplate {
       workerFactoryCustomizer;
   private final @Nullable TemporalOptionsCustomizer<WorkerOptions.Builder> workerCustomizer;
   private final @Nullable TemporalOptionsCustomizer<WorkflowClientOptions.Builder> clientCustomizer;
+  private final @Nullable TemporalOptionsCustomizer<ScheduleClientOptions.Builder>
+      scheduleCustomizer;
 
   private ClientTemplate clientTemplate;
   private WorkersTemplate workersTemplate;
@@ -57,7 +60,8 @@ public NamespaceTemplate(
       @Nullable TestWorkflowEnvironmentAdapter testWorkflowEnvironment,
       @Nullable TemporalOptionsCustomizer<WorkerFactoryOptions.Builder> workerFactoryCustomizer,
       @Nullable TemporalOptionsCustomizer<WorkerOptions.Builder> workerCustomizer,
-      @Nullable TemporalOptionsCustomizer<WorkflowClientOptions.Builder> clientCustomizer) {
+      @Nullable TemporalOptionsCustomizer<WorkflowClientOptions.Builder> clientCustomizer,
+      @Nullable TemporalOptionsCustomizer<ScheduleClientOptions.Builder> scheduleCustomizer) {
     this.properties = properties;
     this.namespaceProperties = namespaceProperties;
     this.workflowServiceStubs = workflowServiceStubs;
@@ -68,6 +72,7 @@ public NamespaceTemplate(
     this.workerFactoryCustomizer = workerFactoryCustomizer;
     this.workerCustomizer = workerCustomizer;
     this.clientCustomizer = clientCustomizer;
+    this.scheduleCustomizer = scheduleCustomizer;
   }
 
   public ClientTemplate getClientTemplate() {
@@ -79,7 +84,8 @@ public ClientTemplate getClientTemplate() {
               tracer,
               workflowServiceStubs,
               testWorkflowEnvironment,
-              clientCustomizer);
+              clientCustomizer,
+              scheduleCustomizer);
     }
     return clientTemplate;
   }

temporal-spring-boot-autoconfigure-alpha/src/main/java/io/temporal/spring/boot/autoconfigure/template/WorkflowClientOptionsTemplate.java

@@ -22,6 +22,7 @@
 
 import io.opentracing.Tracer;
 import io.temporal.client.WorkflowClientOptions;
+import io.temporal.client.schedules.ScheduleClientOptions;
 import io.temporal.common.converter.DataConverter;
 import io.temporal.opentracing.OpenTracingClientInterceptor;
 import io.temporal.opentracing.OpenTracingOptions;
@@ -34,17 +35,21 @@ public class WorkflowClientOptionsTemplate {
   private final @Nonnull String namespace;
   private final @Nullable DataConverter dataConverter;
   private final @Nullable Tracer tracer;
-  private final @Nullable TemporalOptionsCustomizer<WorkflowClientOptions.Builder> customizer;
+  private final @Nullable TemporalOptionsCustomizer<WorkflowClientOptions.Builder> clientCustomizer;
+  private final @Nullable TemporalOptionsCustomizer<ScheduleClientOptions.Builder>
+      scheduleCustomizer;
 
   public WorkflowClientOptionsTemplate(
       @Nonnull String namespace,
       @Nullable DataConverter dataConverter,
       @Nullable Tracer tracer,
-      @Nullable TemporalOptionsCustomizer<WorkflowClientOptions.Builder> customizer) {
+      @Nullable TemporalOptionsCustomizer<WorkflowClientOptions.Builder> clientCustomizer,
+      @Nullable TemporalOptionsCustomizer<ScheduleClientOptions.Builder> scheduleCustomizer) {
     this.namespace = namespace;
     this.dataConverter = dataConverter;
     this.tracer = tracer;
-    this.customizer = customizer;
+    this.clientCustomizer = clientCustomizer;
+    this.scheduleCustomizer = scheduleCustomizer;
   }
 
   public WorkflowClientOptions createWorkflowClientOptions() {
@@ -59,8 +64,20 @@ public WorkflowClientOptions createWorkflowClientOptions() {
       options.setInterceptors(openTracingClientInterceptor);
     }
 
-    if (customizer != null) {
-      options = customizer.customize(options);
+    if (clientCustomizer != null) {
+      options = clientCustomizer.customize(options);
+    }
+
+    return options.build();
+  }
+
+  public ScheduleClientOptions createScheduleClientOptions() {
+    ScheduleClientOptions.Builder options = ScheduleClientOptions.newBuilder();
+    options.setNamespace(namespace);
+    Optional.ofNullable(dataConverter).ifPresent(options::setDataConverter);
+
+    if (scheduleCustomizer != null) {
+      options = scheduleCustomizer.customize(options);
     }
 
     return options.build();

temporal-spring-boot-autoconfigure-alpha/src/test/java/io/temporal/spring/boot/autoconfigure/ClientOnlyTest.java

@@ -21,9 +21,11 @@
 package io.temporal.spring.boot.autoconfigure;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 import io.grpc.health.v1.HealthCheckResponse;
 import io.temporal.client.WorkflowClient;
+import io.temporal.client.schedules.ScheduleClient;
 import io.temporal.testing.TestWorkflowEnvironment;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -44,6 +46,8 @@ public class ClientOnlyTest {
 
   @Autowired WorkflowClient workflowClient;
 
+  @Autowired ScheduleClient scheduleClient;
+
   @BeforeEach
   void setUp() {
     applicationContext.start();
@@ -57,6 +61,12 @@ public void testClientWiring() {
     assertEquals(HealthCheckResponse.ServingStatus.SERVING, healthCheckResponse.getStatus());
   }
 
+  @Test
+  public void testScheduleClientWiring() {
+    assertNotNull(scheduleClient);
+    assertNotNull(scheduleClient.getHandle("test"));
+  }
+
   @ComponentScan(
       excludeFilters =
           @ComponentScan.Filter(