fork options and javadoc

Author: manojdbos

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

@@ -373,7 +373,7 @@ public void cancelWorkflow(String workflowId) {
      *
      * @param workflowId Original workflow Id
      * @param startStep Start execution from this step. Prior steps copied over
-     * @param options Forkoptions forkedWorkflowId, applicationVersion, timeout
+     * @param options {@link ForkOptions} containing forkedWorkflowId, applicationVersion, timeout
      * @return handle to the workflow
      */
     public WorkflowHandle<?> forkWorkflow(String workflowId, int startStep, ForkOptions options) {

src/main/java/dev/dbos/transact/workflow/ForkOptions.java

@@ -1,5 +1,10 @@
 package dev.dbos.transact.workflow;
 
+/**
+ * Configuration options for forking workflows.
+ * This class is immutable and uses the Builder pattern for construction.
+ */
+
 public class ForkOptions {
     private final String forkedWorkflowId;
     private final String applicationVersion;
@@ -11,14 +16,29 @@ private ForkOptions(Builder builder) {
         this.timeoutMS = builder.timeoutMS;
     }
 
+    /**
+     * Gets the forked workflow identifier.
+     *
+     * @return the forked workflow ID, may be null
+     */
     public String getForkedWorkflowId() {
         return forkedWorkflowId;
     }
 
+    /**
+     * Gets the application version for the forked workflow.
+     *
+     * @return the application version, may be null
+     */
     public String getApplicationVersion() {
         return applicationVersion;
     }
 
+    /**
+     * Gets the timeout in milliseconds for the forked workflow.
+     *
+     * @return the timeout in milliseconds
+     */
     public long getTimeoutMS() {
         return timeoutMS;
     }
@@ -27,23 +47,45 @@ public static Builder builder() {
         return new Builder();
     }
 
+    /**
+     * Builder class for constructing ForkOptions instances.
+     * Provides a fluent interface for setting configuration values.
+     */
     public static class Builder {
         private String forkedWorkflowId;
         private String applicationVersion;
         private long timeoutMS;
 
         public Builder() {}
 
+        /**
+         * Sets the forked workflow identifier.
+         *
+         * @param forkedWorkflowId the workflow ID to set
+         * @return this Builder instance for method chaining
+         */
         public Builder forkedWorkflowId(String forkedWorkflowId) {
             this.forkedWorkflowId = forkedWorkflowId;
             return this;
         }
 
+        /**
+         * Sets the application version for the forked workflow.
+         *
+         * @param applicationVersion the application version to set
+         * @return this Builder instance for method chaining
+         */
         public Builder applicationVersion(String applicationVersion) {
             this.applicationVersion = applicationVersion;
             return this;
         }
 
+        /**
+         * Sets the timeout in milliseconds for the forked workflow.
+         *
+         * @param timeoutMS the timeout in milliseconds
+         * @return this Builder instance for method chaining
+         */
         public Builder timeoutMS(long timeoutMS) {
             this.timeoutMS = timeoutMS;
             return this;

src/test/java/dev/dbos/transact/workflow/WorkflowMgmtTest.java

@@ -375,12 +375,12 @@ public void testParentChildFork() {
 
         logger.info("First execution done starting fork") ;
 
-        ForkOptions foptions = new ForkOptions.Builder().build() ;
+        ForkOptions foptions = new ForkOptions.Builder().forkedWorkflowId("f1").build() ;
         WorkflowHandle<?> rstatHandle = dbos.forkWorkflow(workflowId, 0, foptions);
         result = (String) rstatHandle.getResult() ;
         assertEquals("hellohello", result);
         assertEquals(WorkflowState.SUCCESS.name(), rstatHandle.getStatus().getStatus());
-        assertTrue(rstatHandle.getWorkflowId() != workflowId);
+        assertEquals(rstatHandle.getWorkflowId(), "f1");
 
         assertEquals(2, impl.step1Count) ;
         assertEquals(2, impl.step2Count) ;
@@ -396,11 +396,12 @@ public void testParentChildFork() {
 
         logger.info("First execution done starting 2nd fork");
 
+        foptions = new ForkOptions.Builder().forkedWorkflowId("f2").build() ;
         rstatHandle = dbos.forkWorkflow(workflowId, 3, foptions);
         result = (String) rstatHandle.getResult() ;
         assertEquals("hellohello", result);
         assertEquals(WorkflowState.SUCCESS.name(), rstatHandle.getStatus().getStatus());
-        assertTrue(rstatHandle.getWorkflowId() != workflowId);
+        assertEquals(rstatHandle.getWorkflowId(), "f2");
 
         assertEquals(2, impl.step1Count) ;
         assertEquals(2, impl.step2Count) ;
@@ -416,13 +417,14 @@ public void testParentChildFork() {
         assertTrue(stepsRun0.get(2).getChildWorkflowId().equals(steps.get(2).getChildWorkflowId()));
         assertTrue(stepsRun0.get(3).getChildWorkflowId().equals(steps.get(3).getChildWorkflowId()));
 
-        logger.info("First execution done starting 2nd fork");
+        logger.info("2nd execution done starting 3nd fork");
 
+        foptions = new ForkOptions.Builder().forkedWorkflowId("f3").build() ;
         rstatHandle = dbos.forkWorkflow(workflowId, 4, foptions);
         result = (String) rstatHandle.getResult() ;
         assertEquals("hellohello", result);
         assertEquals(WorkflowState.SUCCESS.name(), rstatHandle.getStatus().getStatus());
-        assertTrue(rstatHandle.getWorkflowId() != workflowId);
+        assertEquals(rstatHandle.getWorkflowId(),"f3");
 
         assertEquals(2, impl.step1Count) ;
         assertEquals(2, impl.step2Count) ;