[Core] Replace TimeService with Java Time API (#1620)

## Summary
Migrating the current code to use Java 8 Time API fields instead of the currently used primitive fields.

## Details

The long fields `time`,  `timeStampMillis` and `duration` have been replaced by `Instant` and `Duration` respectively.

These values can now be used instead of older primitives to allow for better representation of time and duration in cucumber without having to worry about precision or granularity.

## Motivation and Context

To allow for more consistent time measurements and reduce custom code.

Author: zutshiy

Diff for: core/src/main/java/io/cucumber/core/api/event/CanonicalEventOrder.java

@@ -72,7 +72,7 @@ public int compare(TestCaseEvent a, TestCaseEvent b) {
                 return line;
             }
 
-            return Long.compare(a.getTimeStamp(), b.getTimeStamp());
+            return a.getInstant().compareTo(b.getInstant());
         }
     }
 }

Diff for: core/src/main/java/io/cucumber/core/api/event/EmbedEvent.java

@@ -1,16 +1,13 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
+
 public final class EmbedEvent extends TestCaseEvent {
     public final byte[] data;
     public final String mimeType;
 
-    @Deprecated
-    public EmbedEvent(Long timeStamp, TestCase testCase, byte[] data, String mimeType) {
-        this(timeStamp, 0, testCase, data, mimeType);
-    }
-
-    public EmbedEvent(Long timeStamp, long timeStampMillis, TestCase testCase, byte[] data, String mimeType) {
-        super(timeStamp, timeStampMillis, testCase);
+    public EmbedEvent(Instant timeInstant, TestCase testCase, byte[] data, String mimeType) {
+        super(timeInstant, testCase);
         this.data = data;
         this.mimeType = mimeType;
     }

Diff for: core/src/main/java/io/cucumber/core/api/event/Event.java

@@ -1,5 +1,6 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
 import java.util.Comparator;
 
 public interface Event {
@@ -31,13 +32,10 @@ public interface Event {
     Comparator<Event> CANONICAL_ORDER = new CanonicalEventOrder();
 
     /**
-     * Returns timestamp in nano seconds since an arbitrary start time.
+     * Returns instant from epoch.
      *
-     * @return timestamp in nano seconds
-     * @see System#nanoTime()
-     * @deprecated prefer {@link TimeStampedEvent#getTimeStampMillis()}
+     * @return time instant in Instant
+     * @see Instant#now()
      */
-    @Deprecated
-    Long getTimeStamp();
-
+    Instant getInstant();
 }

Diff for: core/src/main/java/io/cucumber/core/api/event/Result.java

@@ -2,9 +2,11 @@
 
 import java.io.PrintWriter;
 import java.io.StringWriter;
+import java.time.Duration;
 import java.util.Comparator;
 import java.util.Objects;
 
+import static java.time.Duration.ZERO;
 import static java.util.Locale.ROOT;
 import static java.util.Objects.requireNonNull;
 
@@ -19,9 +21,9 @@ public int compare(Result a, Result b) {
     };
 
     private final Type status;
-    private final Long duration;
+    private final Duration duration;
     private final Throwable error;
-    public static final Result UNDEFINED = new Result(Result.Type.UNDEFINED, 0L, null);
+    public static final Result UNDEFINED = new Result(Result.Type.UNDEFINED, ZERO, null);
     public enum Type {
         PASSED,
         SKIPPED,
@@ -49,10 +51,10 @@ public String firstLetterCapitalizedName() {
      * The result of a step or scenario
      *
      * @param status status of the step or scenario
-     * @param duration the duration in nanoseconds
+     * @param duration the duration
      * @param error the error that caused the failure if any
      */
-    public Result(Result.Type status, Long duration, Throwable error) {
+    public Result(Result.Type status, Duration duration, Throwable error) {
         this.status = requireNonNull(status);
         this.duration = requireNonNull(duration);
         this.error = error;
@@ -62,10 +64,10 @@ public Result.Type getStatus() {
         return status;
     }
 
-    public Long getDuration() {
+    public Duration getDuration() {
         return duration;
     }
-
+    
     public String getErrorMessage() {
         return error != null ? getErrorMessage(error) : null;
     }
@@ -101,7 +103,7 @@ private String getErrorMessage(Throwable error) {
     public String toString() {
         return "Result{" +
             "status=" + status +
-            ", duration=" + duration +
+            ", duration=" + duration.getSeconds() +
             ", error=" + error +
             '}';
     }

Diff for: core/src/main/java/io/cucumber/core/api/event/SnippetsSuggestedEvent.java

@@ -2,6 +2,7 @@
 
 import gherkin.pickles.PickleLocation;
 
+import java.time.Instant;
 import java.util.Collections;
 import java.util.List;
 
@@ -10,13 +11,8 @@ public class SnippetsSuggestedEvent extends TimeStampedEvent {
     public final List<PickleLocation> stepLocations;
     public final List<String> snippets;
 
-    @Deprecated
-    public SnippetsSuggestedEvent(Long timeStamp, String uri, List<PickleLocation> stepLocations, List<String> snippets) {
-        this(timeStamp, 0, uri, stepLocations, snippets);
-    }
-
-    public SnippetsSuggestedEvent(Long timeStamp, long timeStampMillis, String uri, List<PickleLocation> stepLocations, List<String> snippets) {
-        super(timeStamp, timeStampMillis);
+    public SnippetsSuggestedEvent(Instant timeInstant, String uri, List<PickleLocation> stepLocations, List<String> snippets) {
+        super(timeInstant);
         this.uri = uri;
         this.stepLocations = stepLocations;
         this.snippets = Collections.unmodifiableList(snippets);

Diff for: core/src/main/java/io/cucumber/core/api/event/TestCaseEvent.java

@@ -1,11 +1,13 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
+
 public abstract class TestCaseEvent extends TimeStampedEvent {
 
     private final TestCase testCase;
 
-    TestCaseEvent(Long timeStamp, long timeStampMillis, TestCase testCase) {
-        super(timeStamp, timeStampMillis);
+    TestCaseEvent(Instant timeInstant, TestCase testCase) {
+        super(timeInstant);
         this.testCase = testCase;
     }
 

Diff for: core/src/main/java/io/cucumber/core/api/event/TestCaseFinished.java

@@ -1,18 +1,14 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
+
 public final class TestCaseFinished extends TestCaseEvent {
     public final Result result;
     public final TestCase testCase;
 
-    @Deprecated
-    public TestCaseFinished(Long timeStamp, TestCase testCase, Result result) {
-        this(timeStamp, 0, testCase, result);
-    }
-
-    public TestCaseFinished(Long timeStamp, long timeStampMillis, TestCase testCase, Result result) {
-        super(timeStamp, timeStampMillis, testCase);
-        this.testCase = testCase;
-        this.result = result;
-    }
-
+    public TestCaseFinished(Instant timeInstant, TestCase testCase, Result result) {
+      super(timeInstant, testCase);
+      this.testCase = testCase;
+      this.result = result;
+  }
 }

Diff for: core/src/main/java/io/cucumber/core/api/event/TestCaseStarted.java

@@ -1,16 +1,13 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
+
 public final class TestCaseStarted extends TestCaseEvent {
     public final TestCase testCase;
 
-    @Deprecated
-    public TestCaseStarted(Long timeStamp, TestCase testCase) {
-       this(timeStamp, 0L, testCase);
-    }
-
-    public TestCaseStarted(Long timeStamp, long timeStampMillis, TestCase testCase) {
-        super(timeStamp, timeStampMillis, testCase);
-        this.testCase = testCase;
-    }
+    public TestCaseStarted(Instant timeInstant, TestCase testCase) {
+      super(timeInstant, testCase);
+      this.testCase = testCase;
+  }
 
 }

Diff for: core/src/main/java/io/cucumber/core/api/event/TestRunFinished.java

@@ -1,13 +1,10 @@
 package io.cucumber.core.api.event;
 
-public final class TestRunFinished extends TimeStampedEvent {
+import java.time.Instant;
 
-    @Deprecated
-    public TestRunFinished(Long timeStamp) {
-        this(timeStamp, 0);
-    }
+public final class TestRunFinished extends TimeStampedEvent {
 
-    public TestRunFinished(Long timeStamp, long timeStampMillis) {
-        super(timeStamp, timeStampMillis);
+    public TestRunFinished(Instant timeInstant) {
+        super(timeInstant);
     }
 }

Diff for: core/src/main/java/io/cucumber/core/api/event/TestRunStarted.java

@@ -1,13 +1,10 @@
 package io.cucumber.core.api.event;
 
-public final class TestRunStarted extends TimeStampedEvent {
+import java.time.Instant;
 
-    @Deprecated
-    public TestRunStarted(Long timeStamp) {
-        this(timeStamp, 0);
-    }
+public final class TestRunStarted extends TimeStampedEvent {
 
-    public TestRunStarted(Long timeStamp, long timeStampMillis) {
-        super(timeStamp, timeStampMillis);
+    public TestRunStarted(Instant timeInstant) {
+        super(timeInstant);
     }
 }

Diff for: core/src/main/java/io/cucumber/core/api/event/TestSourceRead.java

@@ -1,16 +1,13 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
+
 public final class TestSourceRead extends TimeStampedEvent {
     public final String uri;
     public final String source;
 
-    @Deprecated
-    public TestSourceRead(Long timeStamp, String uri, String source) {
-        this(timeStamp, 0, uri, source);
-    }
-
-    public TestSourceRead(Long timeStamp, long timeStampMillis, String uri, String source) {
-        super(timeStamp, timeStampMillis);
+    public TestSourceRead(Instant timeInstant, String uri, String source) {
+        super(timeInstant);
         this.uri = uri;
         this.source = source;
     }

Diff for: core/src/main/java/io/cucumber/core/api/event/TestStepFinished.java

@@ -1,5 +1,7 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
+
 /**
  * A test step finished event is broadcast when ever a step finishes.
  * <p>
@@ -20,13 +22,8 @@ public final class TestStepFinished extends TestCaseEvent {
     public final TestStep testStep;
     public final Result result;
 
-    @Deprecated
-    public TestStepFinished(Long timeStamp, TestCase testCase, TestStep testStep, Result result) {
-        this(timeStamp, 0, testCase, testStep, result);
-    }
-
-    public TestStepFinished(Long timeStamp, long timeStampMillis, TestCase testCase, TestStep testStep, Result result) {
-        super(timeStamp, timeStampMillis, testCase);
+    public TestStepFinished(Instant timeInstant, TestCase testCase, TestStep testStep, Result result) {
+        super(timeInstant, testCase);
         this.testStep = testStep;
         this.result = result;
     }

Diff for: core/src/main/java/io/cucumber/core/api/event/TestStepStarted.java

@@ -1,5 +1,7 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
+
 /**
  * A test step started event is broadcast when ever a step starts.
  * <p>
@@ -20,13 +22,8 @@
 public final class TestStepStarted extends TestCaseEvent {
     public final TestStep testStep;
 
-    @Deprecated
-    public TestStepStarted(Long timeStamp, TestCase testCase, TestStep testStep) {
-        this(timeStamp, 0, testCase, testStep);
-    }
-
-    public TestStepStarted(Long timeStamp, long timeStampMillis, TestCase testCase, TestStep testStep) {
-        super(timeStamp, timeStampMillis, testCase);
+    public TestStepStarted(Instant timeInstant, TestCase testCase, TestStep testStep) {
+        super(timeInstant, testCase);
         this.testStep = testStep;
     }
 

Diff for: core/src/main/java/io/cucumber/core/api/event/TimeStampedEvent.java

@@ -1,30 +1,24 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
+
 abstract class TimeStampedEvent implements Event {
 
-    private final Long timeStamp;
-    private final long timeStampMillis;
+    private final Instant instant;
 
-    TimeStampedEvent(Long timeStamp, Long timeStampMillis) {
-        this.timeStamp = timeStamp;
-        this.timeStampMillis = timeStampMillis;
+    TimeStampedEvent(Instant timeInstant) {
+        this.instant = timeInstant;
     }
-
+    
     /**
      * {@inheritDoc}
      */
-    @Override
-    public Long getTimeStamp() {
-        return timeStamp;
-    }
 
     /**
-     * Returns timestamp in milliseconds of the epoch.
-     *
-     * @return timestamp in milli seconds
-     * @see System#currentTimeMillis()
+     * {@inheritDoc}
      */
-    public long getTimeStampMillis() {
-        return timeStampMillis;
+    @Override
+    public Instant getInstant() {
+        return instant;
     }
 }

Diff for: core/src/main/java/io/cucumber/core/api/event/WriteEvent.java

@@ -1,15 +1,12 @@
 package io.cucumber.core.api.event;
 
+import java.time.Instant;
+
 public final class WriteEvent extends TestCaseEvent {
     public final String text;
 
-    @Deprecated
-    public WriteEvent(Long timeStamp, TestCase testCase, String text) {
-        this(timeStamp, 0, testCase, text);
-    }
-
-    public WriteEvent(Long timeStamp, long timeStampMillis, TestCase testCase, String text) {
-        super(timeStamp, timeStampMillis, testCase);
+    public WriteEvent(Instant timeInstant, TestCase testCase, String text) {
+        super(timeInstant, testCase);
         this.text = text;
     }
 }

Diff for: core/src/main/java/io/cucumber/core/event/EventBus.java

@@ -1,13 +1,13 @@
 package io.cucumber.core.event;
 
+import java.time.Instant;
+
 import io.cucumber.core.api.event.Event;
 import io.cucumber.core.api.event.EventPublisher;
 
 public interface EventBus extends EventPublisher {
 
-    Long getTime();
-
-    Long getTimeMillis();
+    Instant getInstant();
 
     void send(Event event);