Update internal driver clock usage (#1375)

This update migrates driver internal implementation to `java.time.Clock` and deletes `org.neo4j.driver.internal.util.Clock`.
neo4j · Feb 13, 2023 · 7d0e75c · 7d0e75c
1 parent 4633115
commit 7d0e75c
Show file tree

Hide file tree

Showing 40 changed files with 199 additions and 269 deletions.
diff --git a/driver/src/main/java/org/neo4j/driver/internal/DriverFactory.java b/driver/src/main/java/org/neo4j/driver/internal/DriverFactory.java
@@ -27,6 +27,7 @@
 import io.netty.util.concurrent.EventExecutorGroup;
 import io.netty.util.internal.logging.InternalLoggerFactory;
 import java.net.URI;
+import java.time.Clock;
 import java.util.Objects;
 import java.util.function.Supplier;
 import org.neo4j.driver.AuthToken;
@@ -59,7 +60,6 @@
 import org.neo4j.driver.internal.security.SecurityPlans;
 import org.neo4j.driver.internal.spi.ConnectionPool;
 import org.neo4j.driver.internal.spi.ConnectionProvider;
-import org.neo4j.driver.internal.util.Clock;
 import org.neo4j.driver.internal.util.Futures;
 import org.neo4j.driver.net.ServerAddressResolver;
 
@@ -336,7 +336,7 @@ private static ServerAddressResolver createResolver(Config config) {
      * Creates new {@link Clock}.
      */
     protected Clock createClock() {
-        return Clock.SYSTEM;
+        return Clock.systemUTC();
     }
 
     /**

diff --git a/driver/src/main/java/org/neo4j/driver/internal/async/NetworkConnection.java b/driver/src/main/java/org/neo4j/driver/internal/async/NetworkConnection.java
@@ -25,6 +25,7 @@
 
 import io.netty.channel.Channel;
 import io.netty.channel.ChannelHandler;
+import java.time.Clock;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionStage;
 import java.util.concurrent.TimeUnit;
@@ -45,7 +46,6 @@
 import org.neo4j.driver.internal.metrics.MetricsListener;
 import org.neo4j.driver.internal.spi.Connection;
 import org.neo4j.driver.internal.spi.ResponseHandler;
-import org.neo4j.driver.internal.util.Clock;
 
 /**
  * This connection represents a simple network connection to a remote server. It wraps a channel obtained from a connection pool. The life cycle of this

diff --git a/driver/src/main/java/org/neo4j/driver/internal/async/connection/ChannelConnectorImpl.java b/driver/src/main/java/org/neo4j/driver/internal/async/connection/ChannelConnectorImpl.java
@@ -29,6 +29,7 @@
 import io.netty.resolver.AddressResolverGroup;
 import java.net.InetSocketAddress;
 import java.net.SocketAddress;
+import java.time.Clock;
 import org.neo4j.driver.AuthToken;
 import org.neo4j.driver.AuthTokens;
 import org.neo4j.driver.Logging;
@@ -40,7 +41,6 @@
 import org.neo4j.driver.internal.cluster.RoutingContext;
 import org.neo4j.driver.internal.security.InternalAuthToken;
 import org.neo4j.driver.internal.security.SecurityPlan;
-import org.neo4j.driver.internal.util.Clock;
 
 public class ChannelConnectorImpl implements ChannelConnector {
     private final String userAgent;

diff --git a/driver/src/main/java/org/neo4j/driver/internal/async/connection/NettyChannelInitializer.java b/driver/src/main/java/org/neo4j/driver/internal/async/connection/NettyChannelInitializer.java
@@ -25,14 +25,14 @@
 import io.netty.channel.Channel;
 import io.netty.channel.ChannelInitializer;
 import io.netty.handler.ssl.SslHandler;
+import java.time.Clock;
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.SSLEngine;
 import javax.net.ssl.SSLParameters;
 import org.neo4j.driver.Logging;
 import org.neo4j.driver.internal.BoltServerAddress;
 import org.neo4j.driver.internal.async.inbound.InboundMessageDispatcher;
 import org.neo4j.driver.internal.security.SecurityPlan;
-import org.neo4j.driver.internal.util.Clock;
 
 public class NettyChannelInitializer extends ChannelInitializer<Channel> {
     private final BoltServerAddress address;

diff --git a/driver/src/main/java/org/neo4j/driver/internal/async/pool/ConnectionPoolImpl.java b/driver/src/main/java/org/neo4j/driver/internal/async/pool/ConnectionPoolImpl.java
@@ -28,6 +28,7 @@
 import io.netty.bootstrap.Bootstrap;
 import io.netty.channel.Channel;
 import io.netty.channel.EventLoopGroup;
+import java.time.Clock;
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.Map;
@@ -50,7 +51,6 @@
 import org.neo4j.driver.internal.metrics.MetricsListener;
 import org.neo4j.driver.internal.spi.Connection;
 import org.neo4j.driver.internal.spi.ConnectionPool;
-import org.neo4j.driver.internal.util.Clock;
 import org.neo4j.driver.internal.util.Futures;
 import org.neo4j.driver.net.ServerAddress;
 

diff --git a/driver/src/main/java/org/neo4j/driver/internal/async/pool/NettyChannelHealthChecker.java b/driver/src/main/java/org/neo4j/driver/internal/async/pool/NettyChannelHealthChecker.java
@@ -26,6 +26,7 @@
 import io.netty.channel.pool.ChannelHealthChecker;
 import io.netty.util.concurrent.Future;
 import io.netty.util.concurrent.Promise;
+import java.time.Clock;
 import java.util.Optional;
 import java.util.concurrent.atomic.AtomicReference;
 import org.neo4j.driver.Logger;
@@ -34,7 +35,6 @@
 import org.neo4j.driver.internal.async.connection.AuthorizationStateListener;
 import org.neo4j.driver.internal.handlers.PingResponseHandler;
 import org.neo4j.driver.internal.messaging.request.ResetMessage;
-import org.neo4j.driver.internal.util.Clock;
 
 public class NettyChannelHealthChecker implements ChannelHealthChecker, AuthorizationStateListener {
     private final PoolSettings poolSettings;

diff --git a/driver/src/main/java/org/neo4j/driver/internal/async/pool/NetworkConnectionFactory.java b/driver/src/main/java/org/neo4j/driver/internal/async/pool/NetworkConnectionFactory.java
@@ -19,11 +19,11 @@
 package org.neo4j.driver.internal.async.pool;
 
 import io.netty.channel.Channel;
+import java.time.Clock;
 import org.neo4j.driver.Logging;
 import org.neo4j.driver.internal.async.NetworkConnection;
 import org.neo4j.driver.internal.metrics.MetricsListener;
 import org.neo4j.driver.internal.spi.Connection;
-import org.neo4j.driver.internal.util.Clock;
 
 public class NetworkConnectionFactory implements ConnectionFactory {
     private final Clock clock;

diff --git a/driver/src/main/java/org/neo4j/driver/internal/cluster/ClusterRoutingTable.java b/driver/src/main/java/org/neo4j/driver/internal/cluster/ClusterRoutingTable.java
@@ -22,6 +22,7 @@
 import static java.util.Arrays.asList;
 import static org.neo4j.driver.internal.util.LockUtil.executeWithLock;
 
+import java.time.Clock;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashSet;
@@ -34,7 +35,6 @@
 import org.neo4j.driver.AccessMode;
 import org.neo4j.driver.internal.BoltServerAddress;
 import org.neo4j.driver.internal.DatabaseName;
-import org.neo4j.driver.internal.util.Clock;
 
 public class ClusterRoutingTable implements RoutingTable {
     private static final int MIN_ROUTERS = 1;

diff --git a/...in/java/org/neo4j/driver/internal/cluster/RoutingProcedureClusterCompositionProvider.java b/...in/java/org/neo4j/driver/internal/cluster/RoutingProcedureClusterCompositionProvider.java
@@ -22,6 +22,7 @@
 import static org.neo4j.driver.internal.messaging.request.MultiDatabaseUtil.supportsMultiDatabase;
 import static org.neo4j.driver.internal.messaging.request.MultiDatabaseUtil.supportsRouteMessage;
 
+import java.time.Clock;
 import java.util.List;
 import java.util.Set;
 import java.util.concurrent.CompletionException;
@@ -33,7 +34,6 @@
 import org.neo4j.driver.exceptions.value.ValueException;
 import org.neo4j.driver.internal.DatabaseName;
 import org.neo4j.driver.internal.spi.Connection;
-import org.neo4j.driver.internal.util.Clock;
 
 public class RoutingProcedureClusterCompositionProvider implements ClusterCompositionProvider {
     private static final String PROTOCOL_ERROR_MESSAGE = "Failed to parse '%s' result received from server due to ";

diff --git a/driver/src/main/java/org/neo4j/driver/internal/cluster/RoutingTableRegistryImpl.java b/driver/src/main/java/org/neo4j/driver/internal/cluster/RoutingTableRegistryImpl.java
@@ -21,6 +21,7 @@
 import static java.util.Objects.requireNonNull;
 import static org.neo4j.driver.internal.async.ConnectionContext.PENDING_DATABASE_NAME_EXCEPTION_SUPPLIER;
 
+import java.time.Clock;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
@@ -39,7 +40,6 @@
 import org.neo4j.driver.internal.DatabaseNameUtil;
 import org.neo4j.driver.internal.async.ConnectionContext;
 import org.neo4j.driver.internal.spi.ConnectionPool;
-import org.neo4j.driver.internal.util.Clock;
 import org.neo4j.driver.internal.util.Futures;
 
 public class RoutingTableRegistryImpl implements RoutingTableRegistry {

diff --git a/driver/src/main/java/org/neo4j/driver/internal/cluster/loadbalancing/LoadBalancer.java b/driver/src/main/java/org/neo4j/driver/internal/cluster/loadbalancing/LoadBalancer.java
@@ -29,6 +29,7 @@
 import static org.neo4j.driver.internal.util.Futures.onErrorContinue;
 
 import io.netty.util.concurrent.EventExecutorGroup;
+import java.time.Clock;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
@@ -50,7 +51,6 @@
 import org.neo4j.driver.internal.spi.Connection;
 import org.neo4j.driver.internal.spi.ConnectionPool;
 import org.neo4j.driver.internal.spi.ConnectionProvider;
-import org.neo4j.driver.internal.util.Clock;
 import org.neo4j.driver.internal.util.Futures;
 
 public class LoadBalancer implements ConnectionProvider {

diff --git a/...rc/main/java/org/neo4j/driver/internal/handlers/ChannelReleasingResetResponseHandler.java b/...rc/main/java/org/neo4j/driver/internal/handlers/ChannelReleasingResetResponseHandler.java
@@ -23,11 +23,11 @@
 import static org.neo4j.driver.internal.util.Futures.completedWithNull;
 
 import io.netty.channel.Channel;
+import java.time.Clock;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionStage;
 import org.neo4j.driver.internal.async.inbound.InboundMessageDispatcher;
 import org.neo4j.driver.internal.async.pool.ExtendedChannelPool;
-import org.neo4j.driver.internal.util.Clock;
 
 public class ChannelReleasingResetResponseHandler extends ResetResponseHandler {
     private final Channel channel;

diff --git a/driver/src/main/java/org/neo4j/driver/internal/metrics/InternalMetrics.java b/driver/src/main/java/org/neo4j/driver/internal/metrics/InternalMetrics.java
@@ -21,6 +21,7 @@
 import static java.lang.String.format;
 import static java.util.Collections.unmodifiableCollection;
 
+import java.time.Clock;
 import java.util.Collection;
 import java.util.Map;
 import java.util.Objects;
@@ -30,7 +31,6 @@
 import org.neo4j.driver.Logger;
 import org.neo4j.driver.Logging;
 import org.neo4j.driver.Metrics;
-import org.neo4j.driver.internal.util.Clock;
 import org.neo4j.driver.net.ServerAddress;
 
 final class InternalMetrics implements Metrics, MetricsListener {

diff --git a/driver/src/main/java/org/neo4j/driver/internal/metrics/InternalMetricsProvider.java b/driver/src/main/java/org/neo4j/driver/internal/metrics/InternalMetricsProvider.java
@@ -18,9 +18,9 @@
  */
 package org.neo4j.driver.internal.metrics;
 
+import java.time.Clock;
 import org.neo4j.driver.Logging;
 import org.neo4j.driver.Metrics;
-import org.neo4j.driver.internal.util.Clock;
 
 public final class InternalMetricsProvider implements MetricsProvider {
     private final InternalMetrics metrics;

diff --git a/driver/src/main/java/org/neo4j/driver/internal/metrics/TimeRecorderListenerEvent.java b/driver/src/main/java/org/neo4j/driver/internal/metrics/TimeRecorderListenerEvent.java
@@ -18,7 +18,7 @@
  */
 package org.neo4j.driver.internal.metrics;
 
-import org.neo4j.driver.internal.util.Clock;
+import java.time.Clock;
 
 final class TimeRecorderListenerEvent implements ListenerEvent<Long> {
     private final Clock clock;

diff --git a/driver/src/main/java/org/neo4j/driver/internal/retry/ExponentialBackoffRetryLogic.java b/driver/src/main/java/org/neo4j/driver/internal/retry/ExponentialBackoffRetryLogic.java
@@ -22,6 +22,7 @@
 
 import io.netty.util.concurrent.EventExecutor;
 import io.netty.util.concurrent.EventExecutorGroup;
+import java.time.Clock;
 import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
@@ -35,7 +36,6 @@
 import org.neo4j.driver.exceptions.ClientException;
 import org.neo4j.driver.exceptions.Neo4jException;
 import org.neo4j.driver.exceptions.RetryableException;
-import org.neo4j.driver.internal.util.Clock;
 import org.neo4j.driver.internal.util.Futures;
 import org.reactivestreams.Publisher;
 import reactor.core.publisher.Flux;
@@ -58,18 +58,29 @@ public class ExponentialBackoffRetryLogic implements RetryLogic {
     private final double jitterFactor;
     private final EventExecutorGroup eventExecutorGroup;
     private final Clock clock;
+    private final SleepTask sleepTask;
     private final Logger log;
 
     public ExponentialBackoffRetryLogic(
             long maxTransactionRetryTime, EventExecutorGroup eventExecutorGroup, Clock clock, Logging logging) {
+        this(maxTransactionRetryTime, eventExecutorGroup, clock, logging, Thread::sleep);
+    }
+
+    protected ExponentialBackoffRetryLogic(
+            long maxTransactionRetryTime,
+            EventExecutorGroup eventExecutorGroup,
+            Clock clock,
+            Logging logging,
+            SleepTask sleepTask) {
         this(
                 maxTransactionRetryTime,
                 INITIAL_RETRY_DELAY_MS,
                 RETRY_DELAY_MULTIPLIER,
                 RETRY_DELAY_JITTER_FACTOR,
                 eventExecutorGroup,
                 clock,
-                logging);
+                logging,
+                sleepTask);
     }
 
     ExponentialBackoffRetryLogic(
@@ -79,13 +90,15 @@ public ExponentialBackoffRetryLogic(
             double jitterFactor,
             EventExecutorGroup eventExecutorGroup,
             Clock clock,
-            Logging logging) {
+            Logging logging,
+            SleepTask sleepTask) {
         this.maxRetryTimeMs = maxRetryTimeMs;
         this.initialRetryDelayMs = initialRetryDelayMs;
         this.multiplier = multiplier;
         this.jitterFactor = jitterFactor;
         this.eventExecutorGroup = eventExecutorGroup;
         this.clock = clock;
+        this.sleepTask = sleepTask;
         this.log = logging.getLog(getClass());
 
         verifyAfterConstruction();
@@ -300,7 +313,7 @@ private long computeDelayWithJitter(long delayMs) {
 
     private void sleep(long delayMs) {
         try {
-            clock.sleep(delayMs);
+            sleepTask.sleep(delayMs);
         } catch (InterruptedException e) {
             Thread.currentThread().interrupt();
             throw new IllegalStateException("Retries interrupted", e);
@@ -342,4 +355,9 @@ private static void addSuppressed(Throwable error, List<Throwable> suppressedErr
             }
         }
     }
+
+    @FunctionalInterface
+    public interface SleepTask {
+        void sleep(long millis) throws InterruptedException;
+    }
 }
diff --git a/driver/src/main/java/org/neo4j/driver/internal/svm/MicrometerSubstitutions.java b/driver/src/main/java/org/neo4j/driver/internal/svm/MicrometerSubstitutions.java
@@ -20,14 +20,14 @@
 
 import com.oracle.svm.core.annotate.Substitute;
 import com.oracle.svm.core.annotate.TargetClass;
+import java.time.Clock;
 import org.neo4j.driver.Config;
 import org.neo4j.driver.MetricsAdapter;
 import org.neo4j.driver.internal.DriverFactory;
 import org.neo4j.driver.internal.metrics.DevNullMetricsProvider;
 import org.neo4j.driver.internal.metrics.InternalMetricsProvider;
 import org.neo4j.driver.internal.metrics.MetricsProvider;
 import org.neo4j.driver.internal.metrics.MicrometerMetricsProvider;
-import org.neo4j.driver.internal.util.Clock;
 
 @TargetClass(DriverFactory.class)
 final class Target_org_neo4j_driver_internal_DriverFactory {

diff --git a/driver/src/main/java/org/neo4j/driver/internal/util/Clock.java b/driver/src/main/java/org/neo4j/driver/internal/util/Clock.java
diff --git a/driver/src/test/java/org/neo4j/driver/integration/ConnectionHandlingIT.java b/driver/src/test/java/org/neo4j/driver/integration/ConnectionHandlingIT.java
@@ -35,6 +35,7 @@
 import static org.neo4j.driver.testutil.TestUtil.await;
 
 import io.netty.bootstrap.Bootstrap;
+import java.time.Clock;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionStage;
@@ -68,7 +69,6 @@
 import org.neo4j.driver.internal.security.SecurityPlanImpl;
 import org.neo4j.driver.internal.spi.Connection;
 import org.neo4j.driver.internal.spi.ConnectionPool;
-import org.neo4j.driver.internal.util.Clock;
 import org.neo4j.driver.internal.util.EnabledOnNeo4jWith;
 import org.neo4j.driver.reactive.RxResult;
 import org.neo4j.driver.reactive.RxSession;