Added support for server side retry of workflows (#228)

* Removed minimum attempts to match thrift definition of RetryPolicy

* Added RetryOptions to WorkflowOptions

* Added workflow retry support to TestWorkflowService

Author: mfateev

src/main/java/com/uber/cadence/client/WorkflowOptions.java

@@ -21,13 +21,17 @@
 
 import com.uber.cadence.ChildPolicy;
 import com.uber.cadence.WorkflowIdReusePolicy;
+import com.uber.cadence.common.MethodRetry;
+import com.uber.cadence.common.RetryOptions;
 import com.uber.cadence.internal.common.OptionsUtils;
 import com.uber.cadence.workflow.WorkflowMethod;
 import java.time.Duration;
+import java.util.Objects;
 
 public final class WorkflowOptions {
 
-  public static WorkflowOptions merge(WorkflowMethod a, WorkflowOptions o) {
+  public static WorkflowOptions merge(
+      WorkflowMethod a, MethodRetry methodRetry, WorkflowOptions o) {
     if (a == null) {
       return new WorkflowOptions.Builder(o).validateBuildWithDefaults();
     }
@@ -48,6 +52,7 @@ public static WorkflowOptions merge(WorkflowMethod a, WorkflowOptions o) {
                 a.executionStartToCloseTimeoutSeconds(), o.getExecutionStartToCloseTimeout()))
         .setTaskList(OptionsUtils.merge(a.taskList(), o.getTaskList(), String.class))
         .setChildPolicy(o.getChildPolicy())
+        .setRetryOptions(RetryOptions.merge(methodRetry, o.getRetryOptions()))
         .validateBuildWithDefaults();
   }
 
@@ -65,6 +70,8 @@ public static final class Builder {
 
     private ChildPolicy childPolicy;
 
+    private RetryOptions retryOptions;
+
     public Builder() {}
 
     public Builder(WorkflowOptions o) {
@@ -77,6 +84,7 @@ public Builder(WorkflowOptions o) {
       this.executionStartToCloseTimeout = o.executionStartToCloseTimeout;
       this.taskList = o.taskList;
       this.childPolicy = o.childPolicy;
+      this.retryOptions = o.retryOptions;
     }
 
     /**
@@ -151,14 +159,20 @@ public Builder setChildPolicy(ChildPolicy childPolicy) {
       return this;
     }
 
+    public Builder setRetryOptions(RetryOptions retryOptions) {
+      this.retryOptions = retryOptions;
+      return this;
+    }
+
     public WorkflowOptions build() {
       return new WorkflowOptions(
           workflowId,
           workflowIdReusePolicy,
           executionStartToCloseTimeout,
           taskStartToCloseTimeout,
           taskList,
-          childPolicy);
+          childPolicy,
+          retryOptions);
     }
 
     /**
@@ -170,20 +184,31 @@ public WorkflowOptions validateBuildWithDefaults() {
             "Required property executionStartToCloseTimeout is not set");
       }
       if (taskList == null) {
-        throw new IllegalStateException("Required property taskList is not set");
+        throw new IllegalArgumentException("Required property taskList is not set");
       }
       WorkflowIdReusePolicy policy = workflowIdReusePolicy;
       if (policy == null) {
         policy = WorkflowIdReusePolicy.AllowDuplicateFailedOnly;
       }
+      if (retryOptions != null) {
+        if (retryOptions.getInitialInterval() == null) {
+          throw new IllegalArgumentException(
+              "RetryOptions missing required initialInterval property");
+        }
+        if (retryOptions.getExpiration() == null && retryOptions.getMaximumAttempts() == 0) {
+          throw new IllegalArgumentException(
+              "RetryOptions must specify either expiration or maximum attempts");
+        }
+      }
       return new WorkflowOptions(
           workflowId,
           policy,
           roundUpToSeconds(executionStartToCloseTimeout),
           roundUpToSeconds(
               taskStartToCloseTimeout, OptionsUtils.DEFAULT_TASK_START_TO_CLOSE_TIMEOUT),
           taskList,
-          childPolicy);
+          childPolicy,
+          retryOptions);
     }
   }
 
@@ -199,19 +224,23 @@ public WorkflowOptions validateBuildWithDefaults() {
 
   private final ChildPolicy childPolicy;
 
+  private RetryOptions retryOptions;
+
   private WorkflowOptions(
       String workflowId,
       WorkflowIdReusePolicy workflowIdReusePolicy,
       Duration executionStartToCloseTimeout,
       Duration taskStartToCloseTimeout,
       String taskList,
-      ChildPolicy childPolicy) {
+      ChildPolicy childPolicy,
+      RetryOptions retryOptions) {
     this.workflowId = workflowId;
     this.workflowIdReusePolicy = workflowIdReusePolicy;
     this.executionStartToCloseTimeout = executionStartToCloseTimeout;
     this.taskStartToCloseTimeout = taskStartToCloseTimeout;
     this.taskList = taskList;
     this.childPolicy = childPolicy;
+    this.retryOptions = retryOptions;
   }
 
   public String getWorkflowId() {
@@ -238,38 +267,34 @@ public ChildPolicy getChildPolicy() {
     return childPolicy;
   }
 
+  public RetryOptions getRetryOptions() {
+    return retryOptions;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) return true;
     if (o == null || getClass() != o.getClass()) return false;
-
     WorkflowOptions that = (WorkflowOptions) o;
-
-    if (workflowId != null ? !workflowId.equals(that.workflowId) : that.workflowId != null)
-      return false;
-    if (workflowIdReusePolicy != that.workflowIdReusePolicy) return false;
-    if (executionStartToCloseTimeout != null
-        ? !executionStartToCloseTimeout.equals(that.executionStartToCloseTimeout)
-        : that.executionStartToCloseTimeout != null) return false;
-    if (taskStartToCloseTimeout != null
-        ? !taskStartToCloseTimeout.equals(that.taskStartToCloseTimeout)
-        : that.taskStartToCloseTimeout != null) return false;
-    if (taskList != null ? !taskList.equals(that.taskList) : that.taskList != null) return false;
-    return childPolicy == that.childPolicy;
+    return Objects.equals(workflowId, that.workflowId)
+        && workflowIdReusePolicy == that.workflowIdReusePolicy
+        && Objects.equals(executionStartToCloseTimeout, that.executionStartToCloseTimeout)
+        && Objects.equals(taskStartToCloseTimeout, that.taskStartToCloseTimeout)
+        && Objects.equals(taskList, that.taskList)
+        && childPolicy == that.childPolicy
+        && Objects.equals(retryOptions, that.retryOptions);
   }
 
   @Override
   public int hashCode() {
-    int result = workflowId != null ? workflowId.hashCode() : 0;
-    result = 31 * result + (workflowIdReusePolicy != null ? workflowIdReusePolicy.hashCode() : 0);
-    result =
-        31 * result
-            + (executionStartToCloseTimeout != null ? executionStartToCloseTimeout.hashCode() : 0);
-    result =
-        31 * result + (taskStartToCloseTimeout != null ? taskStartToCloseTimeout.hashCode() : 0);
-    result = 31 * result + (taskList != null ? taskList.hashCode() : 0);
-    result = 31 * result + (childPolicy != null ? childPolicy.hashCode() : 0);
-    return result;
+    return Objects.hash(
+        workflowId,
+        workflowIdReusePolicy,
+        executionStartToCloseTimeout,
+        taskStartToCloseTimeout,
+        taskList,
+        childPolicy,
+        retryOptions);
   }
 
   @Override
@@ -289,6 +314,8 @@ public String toString() {
         + '\''
         + ", childPolicy="
         + childPolicy
+        + ", retryOptions="
+        + retryOptions
         + '}';
   }
 }

src/main/java/com/uber/cadence/common/MethodRetry.java

@@ -37,15 +37,16 @@
 public @interface MethodRetry {
 
   /**
-   * Interval of the first retry. If coefficient is 1.0 then it is used for all retries. Required.
-   * Can be overridden through {@link
+   * Interval of the first retry. If coefficient is 1.0 then it is used for all retries. If not
+   * specified here must be provided through {@link
    * com.uber.cadence.common.RetryOptions.Builder#setInitialInterval(Duration)}.
    */
-  long initialIntervalSeconds();
+  long initialIntervalSeconds() default 0;
 
   /**
-   * Maximum time to retry. Default is forever. When exceeded the retries stop even if maximum
-   * retries is not reached yet.
+   * Maximum time to retry. When exceeded the retries stop even if maximum retries is not reached
+   * yet. If not specified here must be provided through {@link
+   * com.uber.cadence.common.RetryOptions.Builder#setExpiration(Duration)}.
    */
   long expirationSeconds() default 0;
 
@@ -61,12 +62,6 @@
    */
   int maximumAttempts() default 0;
 
-  /**
-   * Minimum number of retries. Even if expired will retry until this number is reached. Must be 1
-   * or bigger. Default is 0.
-   */
-  int minimumAttempts() default 0;
-
   /**
    * Maximum interval between retries. Exponential backoff leads to interval increase. This value is
    * the cap of the increase. Default is 100x {@link #initialIntervalSeconds()}.