Ensure that executions are always complete by default

Author: jhalterman

src/main/java/net/jodah/failsafe/CircuitBreakerExecutor.java

@@ -52,6 +52,6 @@ protected void onSuccess(ExecutionResult result) {
   @Override
   protected ExecutionResult onFailure(ExecutionResult result) {
     policy.recordExecutionFailure(execution);
-    return result.withComplete();
+    return result;
   }
 }

src/main/java/net/jodah/failsafe/ExecutionResult.java

@@ -44,10 +44,11 @@ public class ExecutionResult {
   private final Boolean successAll;
 
   /**
-   * Records an initial execution result where {@code success} is set to true if {@code failure} is not null.
+   * Records an initial execution result with {@code complete} true and {@code success} set to true if {@code failure}
+   * is not null.
    */
   public ExecutionResult(Object result, Throwable failure) {
-    this(result, failure, false, 0, false, failure == null, failure == null);
+    this(result, failure, false, 0, true, failure == null, failure == null);
   }
 
   private ExecutionResult(Object result, Throwable failure, boolean nonResult, long waitNanos, boolean complete,
@@ -62,14 +63,14 @@ private ExecutionResult(Object result, Throwable failure, boolean nonResult, lon
   }
 
   /**
-   * Returns a an ExecutionResult with the {@code result} set, {@code completed} true and {@code success} true.
+   * Returns a an ExecutionResult with the {@code result} set, {@code complete} true and {@code success} true.
    */
   public static ExecutionResult success(Object result) {
-    return new ExecutionResult(result, null);
+    return new ExecutionResult(result, null, false, 0, true, true, true);
   }
 
   /**
-   * Returns a an ExecutionResult with the {@code failure} set, {@code completed} true and {@code success} false.
+   * Returns a an ExecutionResult with the {@code failure} set, {@code complete} true and {@code success} false.
    */
   public static ExecutionResult failure(Throwable failure) {
     return new ExecutionResult(null, failure, false, 0, true, false, false);
@@ -100,8 +101,8 @@ public boolean isSuccess() {
   }
 
   /**
-   * Returns a copy of the ExecutionResult with a non-result, and completed and success set to true. Returns {@code
-   * this} if {@link #success} and {@link #result} are unchanged.
+   * Returns a copy of the ExecutionResult with a non-result, and complete and success set to true. Returns {@code this}
+   * if {@link #success} and {@link #result} are unchanged.
    */
   ExecutionResult withNonResult() {
     return success && this.result == null && nonResult ?
@@ -110,30 +111,38 @@ ExecutionResult withNonResult() {
   }
 
   /**
-   * Returns a copy of the ExecutionResult with the {@code result} value, and completed and success set to true. Returns
+   * Returns a copy of the ExecutionResult with the {@code result} value, and complete and success set to true. Returns
    * {@code this} if {@link #success} and {@link #result} are unchanged.
    */
   public ExecutionResult withResult(Object result) {
     return success && ((this.result == null && result == null) || (this.result != null && this.result.equals(result))) ?
       this :
       new ExecutionResult(result, null, nonResult, waitNanos, true, true, successAll);
   }
+  
+  /**
+   * Returns a copy of the ExecutionResult with {@code complete} set to false, else this if nothing has changed.
+   */
+  ExecutionResult withNotComplete() {
+    return !this.complete ?
+      this :
+      new ExecutionResult(result, failure, nonResult, waitNanos, false, success, successAll);
+  }
 
   /**
-   * Returns a copy of the ExecutionResult with the value set to true, else this if nothing has changed.
+   * Returns a copy of the ExecutionResult with success value of {code false}.
    */
-  public ExecutionResult withComplete() {
-    return this.complete ? this : new ExecutionResult(result, failure, nonResult, waitNanos, true, success, successAll);
+  ExecutionResult withFailure() {
+    return !this.success ? this : new ExecutionResult(result, failure, nonResult, waitNanos, complete, false, false);
   }
 
   /**
-   * Returns a copy of the ExecutionResult with the {@code completed} and {@code success} values.
+   * Returns a copy of the ExecutionResult with the {@code complete} and {@code success} values of {@code true}.
    */
-  ExecutionResult with(boolean completed, boolean success) {
-    return this.complete == completed && this.success == success ?
+  ExecutionResult withSuccess() {
+    return this.complete && this.success ?
       this :
-      new ExecutionResult(result, failure, nonResult, waitNanos, completed, success,
-        successAll == null ? success : success && successAll);
+      new ExecutionResult(result, failure, nonResult, waitNanos, true, true, successAll);
   }
 
   /**
@@ -146,12 +155,12 @@ public ExecutionResult withWaitNanos(long waitNanos) {
   }
 
   /**
-   * Returns a copy of the ExecutionResult with the {@code waitNanos}, {@code completed} and {@code success} values.
+   * Returns a copy of the ExecutionResult with the {@code waitNanos}, {@code complete} and {@code success} values.
    */
-  public ExecutionResult with(long waitNanos, boolean completed, boolean success) {
-    return this.waitNanos == waitNanos && this.complete == completed && this.success == success ?
+  public ExecutionResult with(long waitNanos, boolean complete, boolean success) {
+    return this.waitNanos == waitNanos && this.complete == complete && this.success == success ?
       this :
-      new ExecutionResult(result, failure, nonResult, waitNanos, completed, success,
+      new ExecutionResult(result, failure, nonResult, waitNanos, complete, success,
         successAll == null ? success : success && successAll);
   }
 

src/main/java/net/jodah/failsafe/PolicyExecutor.java

@@ -63,10 +63,10 @@ protected Supplier<ExecutionResult> supply(Supplier<ExecutionResult> supplier, S
    */
   protected ExecutionResult postExecute(ExecutionResult result) {
     if (isFailure(result)) {
-      result = onFailure(result.with(false, false));
+      result = onFailure(result.withFailure());
       callFailureListener(result);
     } else {
-      result = result.with(true, true);
+      result = result.withSuccess();
       onSuccess(result);
       callSuccessListener(result);
     }
@@ -94,12 +94,11 @@ protected Supplier<CompletableFuture<ExecutionResult>> supplyAsync(
   protected CompletableFuture<ExecutionResult> postExecuteAsync(ExecutionResult result, Scheduler scheduler,
     FailsafeFuture<Object> future) {
     if (isFailure(result)) {
-      result = result.with(false, false);
-      return onFailureAsync(result, scheduler, future).whenComplete((postResult, error) -> {
+      return onFailureAsync(result.withFailure(), scheduler, future).whenComplete((postResult, error) -> {
         callFailureListener(postResult);
       });
     } else {
-      result = result.with(true, true);
+      result = result.withSuccess();
       onSuccess(result);
       callSuccessListener(result);
       return CompletableFuture.completedFuture(result);

src/main/java/net/jodah/failsafe/RetryPolicyExecutor.java

@@ -188,6 +188,15 @@ else if (retriesExceededListener != null && !success && retriesExceeded)
     return result.with(waitNanos, completed, success);
   }
 
+  /**
+   * Defaults async executions to not be complete until {@link #onFailure(ExecutionResult) says they are}.
+   */
+  @Override
+  protected CompletableFuture<ExecutionResult> onFailureAsync(ExecutionResult result, Scheduler scheduler,
+    FailsafeFuture<Object> future) {
+    return super.onFailureAsync(result.withNotComplete(), scheduler, future);
+  }
+
   private long getFixedOrRandomDelayNanos(long waitNanos) {
     Duration delay = policy.getDelay();
     Duration delayMin = policy.getDelayMin();

src/main/java/net/jodah/failsafe/TimeoutExecutor.java

@@ -44,7 +44,7 @@ protected ExecutionResult onFailure(ExecutionResult result) {
     // Handle async execution timeouts
     if (!(result.getFailure() instanceof TimeoutExceededException))
       result = ExecutionResult.failure(new TimeoutExceededException(policy));
-    return result.withComplete();
+    return result;
   }
 
   /**