Implemented StartChildWorkflowExecutionParameters's ParentClosePolicy #433 (#437)

* Implemented StartChildWorkflowExecutionParameters's ParentClosePolicy #433
In order to support that ChildWorkflows have the ability to have a
ParentClosePolicy, the field has to be added.

* Added ParentClosePolicy to StateMachines #433

* Added ParentClosePolicy to testWorkflowInput #433

Author: RemcoBuddelmeijer

src/main/java/com/uber/cadence/internal/replay/StartChildWorkflowExecutionParameters.java

@@ -17,6 +17,7 @@
 
 package com.uber.cadence.internal.replay;
 
+import com.uber.cadence.ParentClosePolicy;
 import com.uber.cadence.WorkflowIdReusePolicy;
 import com.uber.cadence.WorkflowType;
 import com.uber.cadence.internal.common.RetryParameters;
@@ -49,6 +50,8 @@ public static final class Builder {
 
     private String cronSchedule;
 
+    private ParentClosePolicy parentClosePolicy;
+
     public Builder setDomain(String domain) {
       this.domain = domain;
       return this;
@@ -105,6 +108,11 @@ public Builder setCronSchedule(String cronSchedule) {
       return this;
     }
 
+    public Builder setParentClosePolicy(ParentClosePolicy parentClosePolicy) {
+      this.parentClosePolicy = parentClosePolicy;
+      return this;
+    }
+
     public StartChildWorkflowExecutionParameters build() {
       return new StartChildWorkflowExecutionParameters(
           domain,
@@ -117,7 +125,8 @@ public StartChildWorkflowExecutionParameters build() {
           workflowType,
           workflowIdReusePolicy,
           retryParameters,
-          cronSchedule);
+          cronSchedule,
+          parentClosePolicy);
     }
   }
 
@@ -143,6 +152,8 @@ public StartChildWorkflowExecutionParameters build() {
 
   private final String cronSchedule;
 
+  private final ParentClosePolicy parentClosePolicy;
+
   private StartChildWorkflowExecutionParameters(
       String domain,
       byte[] input,
@@ -154,7 +165,8 @@ private StartChildWorkflowExecutionParameters(
       WorkflowType workflowType,
       WorkflowIdReusePolicy workflowIdReusePolicy,
       RetryParameters retryParameters,
-      String cronSchedule) {
+      String cronSchedule,
+      ParentClosePolicy parentClosePolicy) {
     this.domain = domain;
     this.input = input;
     this.control = control;
@@ -166,6 +178,7 @@ private StartChildWorkflowExecutionParameters(
     this.workflowIdReusePolicy = workflowIdReusePolicy;
     this.retryParameters = retryParameters;
     this.cronSchedule = cronSchedule;
+    this.parentClosePolicy = parentClosePolicy;
   }
 
   public String getDomain() {
@@ -212,6 +225,10 @@ public String getCronSchedule() {
     return cronSchedule;
   }
 
+  public ParentClosePolicy getParentClosePolicy() {
+    return parentClosePolicy;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) return true;
@@ -227,7 +244,8 @@ public boolean equals(Object o) {
         && Objects.equals(workflowType, that.workflowType)
         && workflowIdReusePolicy == that.workflowIdReusePolicy
         && Objects.equals(retryParameters, that.retryParameters)
-        && Objects.equals(cronSchedule, that.cronSchedule);
+        && Objects.equals(cronSchedule, that.cronSchedule)
+        && Objects.equals(parentClosePolicy, that.parentClosePolicy);
   }
 
   @Override
@@ -243,7 +261,8 @@ public int hashCode() {
             workflowType,
             workflowIdReusePolicy,
             retryParameters,
-            cronSchedule);
+            cronSchedule,
+            parentClosePolicy);
     result = 31 * result + Arrays.hashCode(input);
     return result;
   }
@@ -277,6 +296,8 @@ public String toString() {
         + retryParameters
         + ", cronSchedule="
         + cronSchedule
+        + ", parentClosePolicy="
+        + parentClosePolicy
         + '}';
   }
 }

src/main/java/com/uber/cadence/internal/replay/WorkflowDecisionContext.java

@@ -27,6 +27,7 @@
 import com.uber.cadence.ChildWorkflowExecutionTimedOutEventAttributes;
 import com.uber.cadence.ExternalWorkflowExecutionSignaledEventAttributes;
 import com.uber.cadence.HistoryEvent;
+import com.uber.cadence.ParentClosePolicy;
 import com.uber.cadence.RequestCancelExternalWorkflowExecutionDecisionAttributes;
 import com.uber.cadence.SignalExternalWorkflowExecutionDecisionAttributes;
 import com.uber.cadence.SignalExternalWorkflowExecutionFailedEventAttributes;
@@ -143,6 +144,11 @@ Consumer<Exception> startChildWorkflow(
       attributes.setCronSchedule(parameters.getCronSchedule());
     }
 
+    ParentClosePolicy parentClosePolicy = parameters.getParentClosePolicy();
+    if(parentClosePolicy != null) {
+      attributes.setParentClosePolicy(parentClosePolicy);
+    }
+
     long initiatedEventId = decisions.startChildWorkflowExecution(attributes);
     final OpenChildWorkflowRequestInfo context =
         new OpenChildWorkflowRequestInfo(executionCallback);

src/main/java/com/uber/cadence/internal/sync/SyncDecisionContext.java

@@ -353,6 +353,7 @@ private Promise<byte[]> executeChildWorkflow(
               .setTaskStartToCloseTimeout(options.getTaskStartToCloseTimeout())
               .setWorkflowId(options.getWorkflowId())
               .setWorkflowIdReusePolicy(options.getWorkflowIdReusePolicy())
+              .setParentClosePolicy(options.getParentClosePolicy())
               .build();
       return WorkflowRetryerInternal.retryAsync(
           retryOptions, () -> executeChildWorkflowOnce(name, o1, input, executionResult));
@@ -384,6 +385,7 @@ private Promise<byte[]> executeChildWorkflowOnce(
             .setWorkflowIdReusePolicy(options.getWorkflowIdReusePolicy())
             .setRetryParameters(retryParameters)
             .setCronSchedule(options.getCronSchedule())
+            .setParentClosePolicy(options.getParentClosePolicy())
             .build();
     CompletablePromise<byte[]> result = Workflow.newPromise();
     Consumer<Exception> cancellationCallback =

src/main/java/com/uber/cadence/internal/testservice/StateMachines.java

@@ -446,7 +446,8 @@ private static void initiateChildWorkflow(
             .setWorkflowIdReusePolicy(d.getWorkflowIdReusePolicy())
             .setWorkflowType(d.getWorkflowType())
             .setRetryPolicy(d.getRetryPolicy())
-            .setCronSchedule(d.getCronSchedule());
+            .setCronSchedule(d.getCronSchedule())
+            .setParentClosePolicy(d.getParentClosePolicy());
     HistoryEvent event =
         new HistoryEvent()
             .setEventType(EventType.StartChildWorkflowExecutionInitiated)

src/main/java/com/uber/cadence/workflow/ChildWorkflowOptions.java

@@ -19,6 +19,7 @@
 
 import static com.uber.cadence.internal.common.OptionsUtils.roundUpToSeconds;
 
+import com.uber.cadence.ParentClosePolicy;
 import com.uber.cadence.WorkflowIdReusePolicy;
 import com.uber.cadence.common.CronSchedule;
 import com.uber.cadence.common.MethodRetry;
@@ -76,6 +77,8 @@ public static final class Builder {
 
     private String cronSchedule;
 
+    private ParentClosePolicy parentClosePolicy;
+
     private Map<String, Object> memo;
 
     private Map<String, Object> searchAttributes;
@@ -94,6 +97,7 @@ public Builder(ChildWorkflowOptions source) {
       this.taskList = source.getTaskList();
       this.retryOptions = source.getRetryOptions();
       this.cronSchedule = source.getCronSchedule();
+      this.parentClosePolicy = source.getParentClosePolicy();
       this.memo = source.getMemo();
       this.searchAttributes = source.getSearchAttributes();
     }
@@ -188,6 +192,12 @@ public Builder setCronSchedule(String cronSchedule) {
       return this;
     }
 
+    /** Specifies how this workflow reacts to the death of the parent workflow.  */
+    public Builder setParentClosePolicy(ParentClosePolicy parentClosePolicy) {
+      this.parentClosePolicy = parentClosePolicy;
+      return this;
+    }
+
     /** Specifies additional non-indexed information in result of list workflow. */
     public Builder setMemo(Map<String, Object> memo) {
       this.memo = memo;
@@ -210,6 +220,7 @@ public ChildWorkflowOptions build() {
           taskList,
           retryOptions,
           cronSchedule,
+          parentClosePolicy,
           memo,
           searchAttributes);
     }
@@ -224,6 +235,7 @@ public ChildWorkflowOptions validateAndBuildWithDefaults() {
           taskList,
           retryOptions,
           cronSchedule,
+          parentClosePolicy,
           memo,
           searchAttributes);
     }
@@ -245,6 +257,8 @@ public ChildWorkflowOptions validateAndBuildWithDefaults() {
 
   private final String cronSchedule;
 
+  private final ParentClosePolicy parentClosePolicy;
+
   private final Map<String, Object> memo;
 
   private final Map<String, Object> searchAttributes;
@@ -258,6 +272,7 @@ private ChildWorkflowOptions(
       String taskList,
       RetryOptions retryOptions,
       String cronSchedule,
+      ParentClosePolicy parentClosePolicy,
       Map<String, Object> memo,
       Map<String, Object> searchAttributes) {
     this.domain = domain;
@@ -268,6 +283,7 @@ private ChildWorkflowOptions(
     this.taskList = taskList;
     this.retryOptions = retryOptions;
     this.cronSchedule = cronSchedule;
+    this.parentClosePolicy = parentClosePolicy;
     this.memo = memo;
     this.searchAttributes = searchAttributes;
   }
@@ -304,6 +320,8 @@ public String getCronSchedule() {
     return cronSchedule;
   }
 
+  public ParentClosePolicy getParentClosePolicy() { return parentClosePolicy; }
+
   public Map<String, Object> getMemo() {
     return memo;
   }
@@ -326,6 +344,7 @@ public boolean equals(Object o) {
         && Objects.equals(taskList, that.taskList)
         && Objects.equals(retryOptions, that.retryOptions)
         && Objects.equals(cronSchedule, that.cronSchedule)
+        && Objects.equals(parentClosePolicy, that.parentClosePolicy)
         && Objects.equals(memo, that.memo)
         && Objects.equals(searchAttributes, that.searchAttributes);
   }
@@ -341,6 +360,7 @@ public int hashCode() {
         taskList,
         retryOptions,
         cronSchedule,
+        parentClosePolicy,
         memo,
         searchAttributes);
   }
@@ -367,6 +387,8 @@ public String toString() {
         + retryOptions
         + ", cronSchedule="
         + cronSchedule
+        + ", parentClosePolicy="
+        + parentClosePolicy
         + ", memo='"
         + memo
         + '\''

src/test/resources/resetWorkflowHistory.json

@@ -161,7 +161,7 @@
       },
       "executionStartToCloseTimeoutSeconds": 1000,
       "taskStartToCloseTimeoutSeconds": 10,
-      "childPolicy": "TERMINATE",
+      "parentClosePolicy": "TERMINATE",
       "decisionTaskCompletedEventId": 10,
       "workflowIdReusePolicy": "AllowDuplicateFailedOnly",
       "retryPolicy": {
@@ -432,7 +432,7 @@
       },
       "executionStartToCloseTimeoutSeconds": 1000,
       "taskStartToCloseTimeoutSeconds": 10,
-      "childPolicy": "TERMINATE",
+      "parentClosePolicy": "TERMINATE",
       "decisionTaskCompletedEventId": 28,
       "workflowIdReusePolicy": "AllowDuplicateFailedOnly",
       "retryPolicy": {
@@ -622,7 +622,7 @@
       },
       "executionStartToCloseTimeoutSeconds": 1000,
       "taskStartToCloseTimeoutSeconds": 10,
-      "childPolicy": "TERMINATE",
+      "parentClosePolicy": "TERMINATE",
       "decisionTaskCompletedEventId": 40,
       "workflowIdReusePolicy": "AllowDuplicateFailedOnly",
       "retryPolicy": {
@@ -1063,7 +1063,7 @@
       },
       "executionStartToCloseTimeoutSeconds": 1000,
       "taskStartToCloseTimeoutSeconds": 10,
-      "childPolicy": "TERMINATE",
+      "parentClosePolicy": "TERMINATE",
       "decisionTaskCompletedEventId": 70,
       "workflowIdReusePolicy": "AllowDuplicateFailedOnly",
       "retryPolicy": {

src/test/resources/testChildWorkflowRetryHistory.json

@@ -81,7 +81,7 @@
       "input": "IldvcmtmbG93VGVzdC10ZXN0Q2hpbGRXb3JrZmxvd1JldHJ5W0RvY2tlciBTdGlja3kgT05dLTdmMTY0MmE5LTkwOTItNGFiMS05ODIwLWZmZGY5ZWVjOTVjZSI=",
       "executionStartToCloseTimeoutSeconds": 500,
       "taskStartToCloseTimeoutSeconds": 2,
-      "childPolicy": "TERMINATE",
+      "parentClosePolicy": "TERMINATE",
       "decisionTaskCompletedEventId": 4,
       "workflowIdReusePolicy": "AllowDuplicateFailedOnly"
     }
@@ -277,7 +277,7 @@
       "input": "IldvcmtmbG93VGVzdC10ZXN0Q2hpbGRXb3JrZmxvd1JldHJ5W0RvY2tlciBTdGlja3kgT05dLTdmMTY0MmE5LTkwOTItNGFiMS05ODIwLWZmZGY5ZWVjOTVjZSI=",
       "executionStartToCloseTimeoutSeconds": 500,
       "taskStartToCloseTimeoutSeconds": 2,
-      "childPolicy": "TERMINATE",
+      "parentClosePolicy": "TERMINATE",
       "decisionTaskCompletedEventId": 19,
       "workflowIdReusePolicy": "AllowDuplicateFailedOnly"
     }
@@ -473,7 +473,7 @@
       "input": "IldvcmtmbG93VGVzdC10ZXN0Q2hpbGRXb3JrZmxvd1JldHJ5W0RvY2tlciBTdGlja3kgT05dLTdmMTY0MmE5LTkwOTItNGFiMS05ODIwLWZmZGY5ZWVjOTVjZSI=",
       "executionStartToCloseTimeoutSeconds": 500,
       "taskStartToCloseTimeoutSeconds": 2,
-      "childPolicy": "TERMINATE",
+      "parentClosePolicy": "TERMINATE",
       "decisionTaskCompletedEventId": 34,
       "workflowIdReusePolicy": "AllowDuplicateFailedOnly"
     }