Change ExecutionContext.getStartTime to return Instant.

Fixes #347

Author: jhalterman

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 3.3.0
+
+### API Changes
+
+- `ExecutionContext.getStartTime` now returns an `Instant` rather than a `Duration` object.
+
 # 3.2.4
 
 ### Improvements

core/src/main/java/dev/failsafe/ExecutionContext.java

@@ -18,6 +18,7 @@
 import dev.failsafe.function.CheckedRunnable;
 
 import java.time.Duration;
+import java.time.Instant;
 import java.util.concurrent.CompletableFuture;
 
 /**
@@ -78,9 +79,9 @@ public interface ExecutionContext<R> {
   R getLastResult(R defaultValue);
 
   /**
-   * Returns the time that the initial execution started.
+   * Returns the time that the initial execution started, else {code null} if an execution has not started yet.
    */
-  Duration getStartTime();
+  Instant getStartTime();
 
   /**
    * Returns whether the execution has been cancelled. In this case the implementor should attempt to stop execution.

core/src/main/java/dev/failsafe/ExecutionImpl.java

@@ -22,6 +22,7 @@
 import dev.failsafe.spi.PolicyExecutor;
 
 import java.time.Duration;
+import java.time.Instant;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.ListIterator;
@@ -39,7 +40,7 @@ class ExecutionImpl<R> implements ExecutionInternal<R> {
 
   final List<PolicyExecutor<R>> policyExecutors;
   // When the first execution attempt was started
-  private volatile Duration startTime;
+  private volatile Instant startTime;
   // Number of execution attempts
   private final AtomicInteger attempts;
   // Number of completed executions
@@ -54,7 +55,7 @@ class ExecutionImpl<R> implements ExecutionInternal<R> {
   // The result of the current execution attempt;
   volatile ExecutionResult<R> result;
   // When the most recent execution attempt was started
-  volatile Duration attemptStartTime;
+  private volatile Instant attemptStartTime;
   // The index of a PolicyExecutor that cancelled the execution. Integer.MIN_VALUE represents non-cancelled.
   volatile int cancelledIndex = Integer.MIN_VALUE;
   // The user-provided callback to be called when an execution is cancelled
@@ -71,8 +72,6 @@ class ExecutionImpl<R> implements ExecutionInternal<R> {
    */
   ExecutionImpl(List<? extends Policy<R>> policies) {
     policyExecutors = new ArrayList<>(policies.size());
-    startTime = Duration.ZERO;
-    attemptStartTime = Duration.ZERO;
     attempts = new AtomicInteger();
     executions = new AtomicInteger();
     latest = new AtomicReference<>(this);
@@ -122,8 +121,8 @@ public void onCancel(CheckedRunnable cancelCallback) {
   @Override
   public synchronized void preExecute() {
     if (!preExecuted) {
-      attemptStartTime = Duration.ofNanos(System.nanoTime());
-      if (startTime == Duration.ZERO)
+      attemptStartTime = Instant.now();
+      if (startTime == null)
         startTime = attemptStartTime;
       preExecuted = true;
     }
@@ -220,12 +219,12 @@ public ExecutionInternal<R> getLatest() {
 
   @Override
   public Duration getElapsedTime() {
-    return Duration.ofNanos(System.nanoTime() - startTime.toNanos());
+    return startTime == null ? Duration.ZERO : Duration.between(startTime, Instant.now());
   }
 
   @Override
   public Duration getElapsedAttemptTime() {
-    return Duration.ofNanos(System.nanoTime() - attemptStartTime.toNanos());
+    return attemptStartTime == null ? Duration.ZERO : Duration.between(attemptStartTime, Instant.now());
   }
 
   @Override
@@ -264,7 +263,7 @@ public R getLastResult(R defaultValue) {
   }
 
   @Override
-  public Duration getStartTime() {
+  public Instant getStartTime() {
     return startTime;
   }
 

core/src/main/java/dev/failsafe/Functions.java

@@ -30,7 +30,7 @@
  */
 final class Functions {
   /**
-   * Returns a Supplier that for synchronous executions, that pre-executes the {@code execution}, applies the {@code
+   * Returns a Supplier for synchronous executions that pre-executes the {@code execution}, applies the {@code
    * supplier}, records the result and returns the result. This implementation also handles Thread interrupts.
    *
    * @param <R> result type
@@ -90,7 +90,7 @@ static <R> Function<AsyncExecutionInternal<R>, CompletableFuture<ExecutionResult
   }
 
   /**
-   * Returns a Function for asynchronous executions, that pre-executes the {@code execution}, runs the {@code runnable},
+   * Returns a Function for asynchronous executions that pre-executes the {@code execution}, runs the {@code runnable},
    * and attempts to complete the {@code execution} if a failure occurs. Locks to ensure the resulting supplier cannot
    * be applied multiple times concurrently.
    *
@@ -117,7 +117,7 @@ public synchronized CompletableFuture<ExecutionResult<R>> apply(AsyncExecutionIn
   }
 
   /**
-   * Returns a Function that for asynchronous executions, that pre-executes the {@code execution}, applies the {@code
+   * Returns a Function that for asynchronous executions that pre-executes the {@code execution}, applies the {@code
    * supplier}, records the result and returns a promise containing the result.
    *
    * @param <R> result type

core/src/main/java/dev/failsafe/event/ExecutionEvent.java

@@ -19,6 +19,7 @@
 import dev.failsafe.ExecutionContext;
 
 import java.time.Duration;
+import java.time.Instant;
 
 /**
  * Encapsulates information about a Failsafe execution.
@@ -58,9 +59,9 @@ public int getExecutionCount() {
   }
 
   /**
-   * Returns the time that the initial execution started.
+   * Returns the time that the initial execution started, else {code null} if an execution has not started yet.
    */
-  public Duration getStartTime() {
+  public Instant getStartTime() {
     return context.getStartTime();
   }