Improve WF Schedule API (#350)

Pass a WorkflowSchedule object to createSchedule instead of a bunch of
parameters

Author: devhawk

transact/src/main/java/dev/dbos/transact/DBOS.java

@@ -32,7 +32,6 @@
 import java.lang.reflect.Method;
 import java.time.Duration;
 import java.time.Instant;
-import java.time.ZoneId;
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.Iterator;
@@ -820,25 +819,8 @@ public void setLatestApplicationVersion(@NonNull String versionName) {
    *
    * @param schedule the schedule configuration
    */
-  public void createSchedule(
-      @NonNull String scheduleName,
-      @NonNull String workflowName,
-      @NonNull String className,
-      @NonNull String schedule,
-      @Nullable Object context,
-      boolean backfill,
-      @Nullable ZoneId cronTimeZone,
-      @Nullable String queueName) {
-    ensureLaunched("createSchedule")
-        .createSchedule(
-            scheduleName,
-            workflowName,
-            className,
-            schedule,
-            context,
-            backfill,
-            cronTimeZone,
-            queueName);
+  public void createSchedule(@NonNull WorkflowSchedule schedule) {
+    ensureLaunched("createSchedule").createSchedule(schedule);
   }
 
   /**

transact/src/main/java/dev/dbos/transact/DBOSClient.java

@@ -20,7 +20,6 @@
 
 import java.time.Duration;
 import java.time.Instant;
-import java.time.ZoneId;
 import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
@@ -891,25 +890,8 @@ public void setLatestApplicationVersion(@NonNull String versionName) {
    *
    * @param schedule the schedule configuration
    */
-  public void createSchedule(
-      @NonNull String scheduleName,
-      @NonNull String workflowName,
-      @NonNull String className,
-      @NonNull String schedule,
-      @Nullable Object context,
-      boolean backfill,
-      @Nullable ZoneId cronTimeZone,
-      @Nullable String queueName) {
-    DBOSExecutor.createSchedule(
-        scheduleName,
-        workflowName,
-        className,
-        schedule,
-        context,
-        backfill,
-        cronTimeZone,
-        queueName,
-        systemDatabase::createSchedule);
+  public void createSchedule(@NonNull WorkflowSchedule schedule) {
+    systemDatabase.createSchedule(schedule);
   }
 
   /**

transact/src/main/java/dev/dbos/transact/database/SchedulesDAO.java

@@ -1,5 +1,6 @@
 package dev.dbos.transact.database;
 
+import dev.dbos.transact.execution.SchedulerService;
 import dev.dbos.transact.json.DBOSSerializer;
 import dev.dbos.transact.json.SerializationUtil;
 import dev.dbos.transact.workflow.ScheduleStatus;
@@ -42,6 +43,16 @@ void createSchedule(WorkflowSchedule schedule) throws SQLException {
   static void createSchedule(
       Connection conn, String schema, DBOSSerializer serializer, WorkflowSchedule schedule)
       throws SQLException {
+
+    Objects.requireNonNull(schedule, "schedule must not be null");
+    Objects.requireNonNull(schedule.scheduleName(), "scheduleName must not be null");
+    Objects.requireNonNull(schedule.workflowName(), "workflowName must not be null");
+    // Note, class name may be null since we may be creating portable schedules in a different
+    // language
+    Objects.requireNonNull(schedule.status(), "status must not be null");
+    Objects.requireNonNull(schedule.cron(), "cron must not be null");
+    SchedulerService.CRON_PARSER.parse(schedule.cron());
+
     String sql =
         """
         INSERT INTO "%s".workflow_schedules
@@ -65,7 +76,7 @@ static void createSchedule(
       ps.setString(3, schedule.workflowName());
       ps.setString(4, schedule.className());
       ps.setString(5, schedule.cron());
-      ps.setString(6, Objects.requireNonNull(schedule.status()).name());
+      ps.setString(6, schedule.status().name());
       ps.setString(7, serializedContext.serializedValue());
       ps.setString(8, schedule.lastFiredAt() != null ? schedule.lastFiredAt().toString() : null);
       ps.setBoolean(9, schedule.automaticBackfill());

transact/src/main/java/dev/dbos/transact/execution/DBOSExecutor.java

@@ -51,7 +51,6 @@
 import java.lang.reflect.InvocationTargetException;
 import java.time.Duration;
 import java.time.Instant;
-import java.time.ZoneId;
 import java.time.ZoneOffset;
 import java.util.ArrayList;
 import java.util.Collection;
@@ -72,7 +71,6 @@
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicReference;
-import java.util.function.Consumer;
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
@@ -936,70 +934,19 @@ public void setLatestApplicationVersion(String versionName) {
     systemDatabase.updateApplicationVersionTimestamp(versionName, Instant.now());
   }
 
-  public static void createSchedule(
-      @NonNull String scheduleName,
-      @NonNull String workflowName,
-      @NonNull String className,
-      @NonNull String schedule,
-      @Nullable Object context,
-      boolean automaticBackfill,
-      @Nullable ZoneId cronTimeZone,
-      @Nullable String queueName,
-      @NonNull Consumer<WorkflowSchedule> scheduleConsumer) {
-    Objects.requireNonNull(scheduleName, "scheduleName cannot be null");
-    Objects.requireNonNull(workflowName, "workflowName cannot be null");
-    Objects.requireNonNull(className, "className cannot be null");
-    // validate schedule CRON
-    SchedulerService.CRON_PARSER.parse(Objects.requireNonNull(schedule, "schedule cannot be null"));
-
-    final var wfSchedule =
-        new WorkflowSchedule(
-            UUID.randomUUID().toString(),
-            scheduleName,
-            workflowName,
-            className,
-            schedule,
-            ScheduleStatus.ACTIVE,
-            context,
-            null,
-            automaticBackfill,
-            cronTimeZone,
-            queueName);
+  public void createSchedule(@NonNull WorkflowSchedule schedule) {
 
-    scheduleConsumer.accept(wfSchedule);
-  }
-
-  public void createSchedule(
-      @NonNull String scheduleName,
-      @NonNull String workflowName,
-      @NonNull String className,
-      @NonNull String schedule,
-      @Nullable Object context,
-      boolean automaticBackfill,
-      @Nullable ZoneId cronTimeZone,
-      @Nullable String queueName) {
+    Objects.requireNonNull(schedule, "schedule cannot be null");
+    validateQueue(schedule.queueName());
+    validateWorkflow(schedule.workflowName(), schedule.className());
 
-    validateQueue(queueName);
-    validateWorkflow(workflowName, className);
-
-    DBOSExecutor.createSchedule(
-        scheduleName,
-        workflowName,
-        className,
-        schedule,
-        context,
-        automaticBackfill,
-        cronTimeZone,
-        queueName,
-        wfSchedule -> {
-          this.callFunctionAsStep(
-              () -> {
-                systemDatabase.createSchedule(wfSchedule);
-                return null;
-              },
-              "DBOS.createSchedule",
-              null);
-        });
+    this.callFunctionAsStep(
+        () -> {
+          systemDatabase.createSchedule(schedule);
+          return null;
+        },
+        "DBOS.createSchedule",
+        null);
   }
 
   public Optional<WorkflowSchedule> getSchedule(String name) {