Update BoltConnectionProvider (#1610)

The BoltConnectionProvider will now accept `address` and some other additional parameters in its methods.

Author: injectives

bolt-api-netty/src/main/java/org/neo4j/driver/internal/bolt/basicimpl/NettyBoltConnectionProvider.java

@@ -58,56 +58,39 @@
 public final class NettyBoltConnectionProvider implements BoltConnectionProvider {
     private final LoggingProvider logging;
     private final System.Logger log;
-
     private final ConnectionProvider connectionProvider;
-
-    private BoltServerAddress address;
-
-    private RoutingContext routingContext;
-    private BoltAgent boltAgent;
-    private String userAgent;
-    private int connectTimeoutMillis;
-    private CompletableFuture<Void> closeFuture;
-    private MetricsListener metricsListener;
+    private final MetricsListener metricsListener;
     private final Clock clock;
     private final ValueFactory valueFactory;
 
+    private CompletableFuture<Void> closeFuture;
+
     public NettyBoltConnectionProvider(
             EventLoopGroup eventLoopGroup,
             Clock clock,
             DomainNameResolver domainNameResolver,
             LocalAddress localAddress,
             LoggingProvider logging,
-            ValueFactory valueFactory) {
+            ValueFactory valueFactory,
+            MetricsListener metricsListener) {
         Objects.requireNonNull(eventLoopGroup);
         this.clock = Objects.requireNonNull(clock);
         this.logging = Objects.requireNonNull(logging);
         this.log = logging.getLog(getClass());
         this.connectionProvider = ConnectionProviders.netty(
                 eventLoopGroup, clock, domainNameResolver, localAddress, logging, valueFactory);
         this.valueFactory = Objects.requireNonNull(valueFactory);
+        this.metricsListener = NoopMetricsListener.getInstance();
+        InternalLoggerFactory.setDefaultFactory(new NettyLogging(logging));
     }
 
     @Override
-    public CompletionStage<Void> init(
+    public CompletionStage<BoltConnection> connect(
             BoltServerAddress address,
             RoutingContext routingContext,
             BoltAgent boltAgent,
             String userAgent,
             int connectTimeoutMillis,
-            MetricsListener metricsListener) {
-        this.address = address;
-        this.routingContext = routingContext;
-        this.boltAgent = boltAgent;
-        this.userAgent = userAgent;
-        this.connectTimeoutMillis = connectTimeoutMillis;
-        this.metricsListener = NoopMetricsListener.getInstance();
-        InternalLoggerFactory.setDefaultFactory(new NettyLogging(logging));
-        return CompletableFuture.completedStage(null);
-    }
-
-    @Override
-    public CompletionStage<BoltConnection> connect(
             SecurityPlan securityPlan,
             DatabaseName databaseName,
             Supplier<CompletionStage<AuthToken>> authTokenStageSupplier,
@@ -180,8 +163,20 @@ public CompletionStage<BoltConnection> connect(
     }
 
     @Override
-    public CompletionStage<Void> verifyConnectivity(SecurityPlan securityPlan, AuthToken authToken) {
+    public CompletionStage<Void> verifyConnectivity(
+            BoltServerAddress address,
+            RoutingContext routingContext,
+            BoltAgent boltAgent,
+            String userAgent,
+            int connectTimeoutMillis,
+            SecurityPlan securityPlan,
+            AuthToken authToken) {
         return connect(
+                        address,
+                        routingContext,
+                        boltAgent,
+                        userAgent,
+                        connectTimeoutMillis,
                         securityPlan,
                         null,
                         () -> CompletableFuture.completedStage(authToken),
@@ -196,8 +191,20 @@ public CompletionStage<Void> verifyConnectivity(SecurityPlan securityPlan, AuthT
     }
 
     @Override
-    public CompletionStage<Boolean> supportsMultiDb(SecurityPlan securityPlan, AuthToken authToken) {
+    public CompletionStage<Boolean> supportsMultiDb(
+            BoltServerAddress address,
+            RoutingContext routingContext,
+            BoltAgent boltAgent,
+            String userAgent,
+            int connectTimeoutMillis,
+            SecurityPlan securityPlan,
+            AuthToken authToken) {
         return connect(
+                        address,
+                        routingContext,
+                        boltAgent,
+                        userAgent,
+                        connectTimeoutMillis,
                         securityPlan,
                         null,
                         () -> CompletableFuture.completedStage(authToken),
@@ -215,8 +222,20 @@ public CompletionStage<Boolean> supportsMultiDb(SecurityPlan securityPlan, AuthT
     }
 
     @Override
-    public CompletionStage<Boolean> supportsSessionAuth(SecurityPlan securityPlan, AuthToken authToken) {
+    public CompletionStage<Boolean> supportsSessionAuth(
+            BoltServerAddress address,
+            RoutingContext routingContext,
+            BoltAgent boltAgent,
+            String userAgent,
+            int connectTimeoutMillis,
+            SecurityPlan securityPlan,
+            AuthToken authToken) {
         return connect(
+                        address,
+                        routingContext,
+                        boltAgent,
+                        userAgent,
+                        connectTimeoutMillis,
                         securityPlan,
                         null,
                         () -> CompletableFuture.completedStage(authToken),

bolt-api-pooled/src/main/java/org/neo4j/driver/internal/bolt/pooledimpl/PooledBoltConnectionProvider.java

@@ -66,11 +66,15 @@ public class PooledBoltConnectionProvider implements BoltConnectionProvider {
     private final long maxLifetime;
     private final long idleBeforeTest;
     private final Clock clock;
-    private MetricsListener metricsListener;
-    private CompletionStage<Void> closeStage;
-    private BoltServerAddress address;
-    private String poolId;
+    private final MetricsListener metricsListener;
+    private final BoltServerAddress address;
+    private final RoutingContext routingContext;
+    private final BoltAgent boltAgent;
+    private final String userAgent;
+    private final int connectTimeoutMillis;
+    private final String poolId;
 
+    private CompletionStage<Void> closeStage;
     private long minAuthTimestamp;
 
     public PooledBoltConnectionProvider(
@@ -80,7 +84,13 @@ public PooledBoltConnectionProvider(
             long maxLifetime,
             long idleBeforeTest,
             Clock clock,
-            LoggingProvider logging) {
+            LoggingProvider logging,
+            MetricsListener metricsListener,
+            BoltServerAddress address,
+            RoutingContext routingContext,
+            BoltAgent boltAgent,
+            String userAgent,
+            int connectTimeoutMillis) {
         this.boltConnectionProvider = boltConnectionProvider;
         this.pooledConnectionEntries = new ArrayList<>();
         this.pendingAcquisitions = new ArrayDeque<>(100);
@@ -90,19 +100,13 @@ public PooledBoltConnectionProvider(
         this.idleBeforeTest = idleBeforeTest;
         this.clock = Objects.requireNonNull(clock);
         this.log = logging.getLog(getClass());
-    }
-
-    @Override
-    public CompletionStage<Void> init(
-            BoltServerAddress address,
-            RoutingContext routingContext,
-            BoltAgent boltAgent,
-            String userAgent,
-            int connectTimeoutMillis,
-            MetricsListener metricsListener) {
+        this.metricsListener = Objects.requireNonNull(metricsListener);
         this.address = Objects.requireNonNull(address);
+        this.routingContext = Objects.requireNonNull(routingContext);
+        this.boltAgent = Objects.requireNonNull(boltAgent);
+        this.userAgent = Objects.requireNonNull(userAgent);
+        this.connectTimeoutMillis = connectTimeoutMillis;
         this.poolId = poolId(address);
-        this.metricsListener = Objects.requireNonNull(metricsListener);
         metricsListener.registerPoolMetrics(
                 poolId,
                 address,
@@ -120,13 +124,16 @@ public CompletionStage<Void> init(
                                 .count();
                     }
                 });
-        return boltConnectionProvider.init(
-                address, routingContext, boltAgent, userAgent, connectTimeoutMillis, metricsListener);
     }
 
     @SuppressWarnings({"ReassignedVariable"})
     @Override
     public CompletionStage<BoltConnection> connect(
+            BoltServerAddress ignoredAddress,
+            RoutingContext ignoredRoutingContext,
+            BoltAgent ignoredBoltAgent,
+            String ignoredUserAgent,
+            int ignoredConnectTimeoutMillis,
             SecurityPlan securityPlan,
             DatabaseName databaseName,
             Supplier<CompletionStage<AuthToken>> authTokenStageSupplier,
@@ -334,6 +341,11 @@ private void connect(
                 var entry = connectionEntryWithMetadata.connectionEntry;
                 boltConnectionProvider
                         .connect(
+                                address,
+                                routingContext,
+                                boltAgent,
+                                userAgent,
+                                connectTimeoutMillis,
                                 securityPlan,
                                 databaseName,
                                 empty.get()
@@ -502,8 +514,20 @@ private CompletionStage<Void> livenessCheckStage(ConnectionEntry entry) {
     }
 
     @Override
-    public CompletionStage<Void> verifyConnectivity(SecurityPlan securityPlan, AuthToken authToken) {
+    public CompletionStage<Void> verifyConnectivity(
+            BoltServerAddress ignoredAddress,
+            RoutingContext ignoredRoutingContext,
+            BoltAgent ignoredBoltAgent,
+            String ignoredUserAgent,
+            int ignoredConnectTimeoutMillis,
+            SecurityPlan securityPlan,
+            AuthToken authToken) {
         return connect(
+                        address,
+                        routingContext,
+                        boltAgent,
+                        userAgent,
+                        connectTimeoutMillis,
                         securityPlan,
                         null,
                         () -> CompletableFuture.completedStage(authToken),
@@ -518,8 +542,20 @@ public CompletionStage<Void> verifyConnectivity(SecurityPlan securityPlan, AuthT
     }
 
     @Override
-    public CompletionStage<Boolean> supportsMultiDb(SecurityPlan securityPlan, AuthToken authToken) {
+    public CompletionStage<Boolean> supportsMultiDb(
+            BoltServerAddress ignoredAddress,
+            RoutingContext ignoredRoutingContext,
+            BoltAgent ignoredBoltAgent,
+            String ignoredUserAgent,
+            int ignoredConnectTimeoutMillis,
+            SecurityPlan securityPlan,
+            AuthToken authToken) {
         return connect(
+                        address,
+                        routingContext,
+                        boltAgent,
+                        userAgent,
+                        connectTimeoutMillis,
                         securityPlan,
                         null,
                         () -> CompletableFuture.completedStage(authToken),
@@ -537,8 +573,20 @@ public CompletionStage<Boolean> supportsMultiDb(SecurityPlan securityPlan, AuthT
     }
 
     @Override
-    public CompletionStage<Boolean> supportsSessionAuth(SecurityPlan securityPlan, AuthToken authToken) {
+    public CompletionStage<Boolean> supportsSessionAuth(
+            BoltServerAddress ignoredAddress,
+            RoutingContext ignoredRoutingContext,
+            BoltAgent ignoredBoltAgent,
+            String ignoredUserAgent,
+            int ignoredConnectTimeoutMillis,
+            SecurityPlan securityPlan,
+            AuthToken authToken) {
         return connect(
+                        address,
+                        routingContext,
+                        boltAgent,
+                        userAgent,
+                        connectTimeoutMillis,
                         securityPlan,
                         null,
                         () -> CompletableFuture.completedStage(authToken),