Align driver with latest revision of ExecuteQuery ADR

Rename `QueryTask` occurrences with `ExecuteQuery`

Rename default `ExecuteQuery`'s default `BookmarkManager` getter

Make default `ExecuteQuery`'s default `BookmarkManager` unchangeable

Author: fbiville

driver/clirr-ignored-differences.xml

@@ -412,19 +412,13 @@
     <difference>
         <className>org/neo4j/driver/Driver</className>
         <differenceType>7012</differenceType>
-        <method>org.neo4j.driver.QueryTask queryTask(java.lang.String)</method>
+        <method>org.neo4j.driver.ExecuteQueryBuilder executeQueryBuilder(java.lang.String)</method>
     </difference>
 
     <difference>
         <className>org/neo4j/driver/Driver</className>
         <differenceType>7012</differenceType>
-        <method>org.neo4j.driver.BookmarkManager queryBookmarkManager()</method>
-    </difference>
-
-    <difference>
-        <className>org/neo4j/driver/Driver</className>
-        <differenceType>7012</differenceType>
-        <method>org.neo4j.driver.BookmarkManager queryTaskBookmarkManager()</method>
+        <method>org.neo4j.driver.BookmarkManager defaultExecuteQueryBookmarkManager()</method>
     </difference>
 
 </differences>

driver/src/main/java/org/neo4j/driver/Config.java

@@ -75,8 +75,6 @@ public final class Config implements Serializable {
 
     private static final Config EMPTY = builder().build();
 
-    private final BookmarkManager queryBookmarkManager;
-
     /**
      * User defined logging
      */
@@ -104,7 +102,6 @@ public final class Config implements Serializable {
     private final MetricsAdapter metricsAdapter;
 
     private Config(ConfigBuilder builder) {
-        this.queryBookmarkManager = builder.queryBookmarkManager;
         this.logging = builder.logging;
         this.logLeakedSessions = builder.logLeakedSessions;
 
@@ -126,21 +123,6 @@ private Config(ConfigBuilder builder) {
         this.metricsAdapter = builder.metricsAdapter;
     }
 
-    /**
-     * A {@link BookmarkManager} implementation for the driver to use on
-     * {@link Driver#queryTask(String)} method and its variants by default.
-     * <p>
-     * Please note that sessions will not use this automatically, but it is possible to enable it explicitly
-     * using {@link SessionConfig.Builder#withBookmarkManager(BookmarkManager)}.
-     *
-     * @return bookmark manager, must not be {@code null}
-     * @since 5.5
-     */
-    @Experimental
-    public BookmarkManager queryTaskBookmarkManager() {
-        return queryBookmarkManager;
-    }
-
     /**
      * Logging provider
      *
@@ -280,8 +262,6 @@ public String userAgent() {
      * Used to build new config instances
      */
     public static final class ConfigBuilder {
-        private BookmarkManager queryBookmarkManager =
-                BookmarkManagers.defaultManager(BookmarkManagerConfig.builder().build());
         private Logging logging = DEV_NULL_LOGGING;
         private boolean logLeakedSessions;
         private int maxConnectionPoolSize = PoolSettings.DEFAULT_MAX_CONNECTION_POOL_SIZE;
@@ -301,24 +281,6 @@ public static final class ConfigBuilder {
 
         private ConfigBuilder() {}
 
-        /**
-         * Sets a {@link BookmarkManager} implementation for the driver to use on
-         * {@link Driver#queryTask(String)} method and its variants by default.
-         * <p>
-         * Please note that sessions will not use this automatically, but it is possible to enable it explicitly
-         * using {@link SessionConfig.Builder#withBookmarkManager(BookmarkManager)}.
-         *
-         * @param bookmarkManager bookmark manager, must not be {@code null}
-         * @return this builder
-         * @since 5.5
-         */
-        @Experimental
-        public ConfigBuilder withQueryTaskBookmarkManager(BookmarkManager bookmarkManager) {
-            Objects.requireNonNull(bookmarkManager, "bookmarkManager must not be null");
-            this.queryBookmarkManager = bookmarkManager;
-            return this;
-        }
-
         /**
          * Provide a logging implementation for the driver to use. Java logging framework {@link java.util.logging} with {@link Level#INFO} is used by default.
          * Callers are expected to either implement {@link Logging} interface or provide one of the existing implementations available from static factory

driver/src/main/java/org/neo4j/driver/Driver.java

@@ -64,24 +64,24 @@
  */
 public interface Driver extends AutoCloseable {
     /**
-     * Creates a new {@link QueryTask} instance that executes a query in a managed transaction with automatic retries on
+     * Creates a new {@link ExecuteQueryBuilder} instance that executes a query in a managed transaction with automatic retries on
      * retryable errors.
      *
      * @param query query string
      * @return new query task instance
      * @since 5.5
      */
     @Experimental
-    QueryTask queryTask(String query);
+    ExecuteQueryBuilder executeQueryBuilder(String query);
 
     /**
-     * Returns an instance of {@link BookmarkManager} used by {@link QueryTask} instances by default.
+     * Returns an instance of {@link BookmarkManager} used by {@link ExecuteQueryBuilder} instances by default.
      *
      * @return bookmark manager, must not be {@code null}
      * @since 5.6
      */
     @Experimental
-    BookmarkManager queryTaskBookmarkManager();
+    BookmarkManager defaultExecuteQueryBookmarkManager();
 
     /**
      * Return a flag to indicate whether or not encryption is used for this driver.

driver/src/main/java/org/neo4j/driver/QueryTask.java renamed to driver/src/main/java/org/neo4j/driver/ExecuteQueryBuilder.java

@@ -36,10 +36,9 @@
  * methods like {@link Session#executeWrite(TransactionCallback)}, {@link Session#executeWriteWithoutResult(Consumer)}
  * and {@link Session#executeRead(TransactionCallback)} (there are also overloaded options available).
  * <p>
- * Causal consistency is managed via driver's {@link BookmarkManager} that is enabled by default and may
- * be replaced using {@link Config.ConfigBuilder#withQueryTaskBookmarkManager(BookmarkManager)}. It is also possible
+ * Causal consistency is managed via driver's {@link BookmarkManager} that is enabled by default. It is possible
  * to use a different {@link BookmarkManager} or disable it via
- * {@link QueryConfig.Builder#withBookmarkManager(BookmarkManager)} on individual basis.
+ * {@link ExecuteQueryConfig.Builder#withBookmarkManager(BookmarkManager)} on individual basis.
  * <p>
  * Sample usage:
  * <pre>
@@ -98,24 +97,24 @@
  * @since 5.5
  */
 @Experimental
-public interface QueryTask {
+public interface ExecuteQueryBuilder {
     /**
      * Sets query parameters.
      *
      * @param parameters parameters map, must not be {@code null}
      * @return a new query task
      */
-    QueryTask withParameters(Map<String, Object> parameters);
+    ExecuteQueryBuilder withParameters(Map<String, Object> parameters);
 
     /**
-     * Sets {@link QueryConfig}.
+     * Sets {@link ExecuteQueryConfig}.
      * <p>
-     * By default, {@link QueryTask} has {@link QueryConfig#defaultConfig()} value.
+     * By default, {@link ExecuteQueryBuilder} has {@link ExecuteQueryConfig#defaultConfig()} value.
      *
      * @param config query config, must not be {@code null}
      * @return a new query task
      */
-    QueryTask withConfig(QueryConfig config);
+    ExecuteQueryBuilder withConfig(ExecuteQueryConfig config);
 
     /**
      * Executes query, collects all results eagerly and returns a result.

driver/src/main/java/org/neo4j/driver/QueryConfig.java renamed to driver/src/main/java/org/neo4j/driver/ExecuteQueryConfig.java

@@ -27,15 +27,15 @@
 import org.neo4j.driver.util.Experimental;
 
 /**
- * Query configuration used by {@link Driver#queryTask(String)} and its variants.
+ * Query configuration used by {@link Driver#executeQueryBuilder(String)} and its variants.
  * @since 5.5
  */
 @Experimental
-public final class QueryConfig implements Serializable {
+public final class ExecuteQueryConfig implements Serializable {
     @Serial
     private static final long serialVersionUID = -2632780731598141754L;
 
-    private static final QueryConfig DEFAULT = builder().build();
+    private static final ExecuteQueryConfig DEFAULT = builder().build();
 
     private final RoutingControl routing;
     private final String database;
@@ -48,11 +48,11 @@ public final class QueryConfig implements Serializable {
      *
      * @return config value
      */
-    public static QueryConfig defaultConfig() {
+    public static ExecuteQueryConfig defaultConfig() {
         return DEFAULT;
     }
 
-    private QueryConfig(Builder builder) {
+    private ExecuteQueryConfig(Builder builder) {
         this.routing = builder.routing;
         this.database = builder.database;
         this.impersonatedUser = builder.impersonatedUser;
@@ -113,7 +113,7 @@ public Optional<BookmarkManager> bookmarkManager(BookmarkManager defaultBookmark
     public boolean equals(Object o) {
         if (this == o) return true;
         if (o == null || getClass() != o.getClass()) return false;
-        QueryConfig that = (QueryConfig) o;
+        ExecuteQueryConfig that = (ExecuteQueryConfig) o;
         return useDefaultBookmarkManager == that.useDefaultBookmarkManager
                 && routing == that.routing
                 && Objects.equals(database, that.database)
@@ -137,7 +137,7 @@ public String toString() {
     }
 
     /**
-     * Builder used to configure {@link QueryConfig} which will be used to execute a query.
+     * Builder used to configure {@link ExecuteQueryConfig} which will be used to execute a query.
      */
     public static final class Builder {
         private RoutingControl routing = RoutingControl.WRITERS;
@@ -207,10 +207,10 @@ public Builder withBookmarkManager(BookmarkManager bookmarkManager) {
         /**
          * Create a config instance from this builder.
          *
-         * @return a new {@link QueryConfig} instance.
+         * @return a new {@link ExecuteQueryConfig} instance.
          */
-        public QueryConfig build() {
-            return new QueryConfig(this);
+        public ExecuteQueryConfig build() {
+            return new ExecuteQueryConfig(this);
         }
     }
 }

driver/src/main/java/org/neo4j/driver/internal/DriverFactory.java

@@ -32,6 +32,9 @@
 import java.util.function.Supplier;
 import org.neo4j.driver.AuthToken;
 import org.neo4j.driver.AuthTokens;
+import org.neo4j.driver.BookmarkManager;
+import org.neo4j.driver.BookmarkManagerConfig;
+import org.neo4j.driver.BookmarkManagers;
 import org.neo4j.driver.Config;
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.Logger;
@@ -269,8 +272,7 @@ protected InternalDriver createRoutingDriver(
      */
     protected InternalDriver createDriver(
             SecurityPlan securityPlan, SessionFactory sessionFactory, MetricsProvider metricsProvider, Config config) {
-        return new InternalDriver(
-                config.queryTaskBookmarkManager(), securityPlan, sessionFactory, metricsProvider, config.logging());
+        return new InternalDriver(securityPlan, sessionFactory, metricsProvider, config.logging());
     }
 
     /**

driver/src/main/java/org/neo4j/driver/internal/InternalDriver.java

@@ -25,13 +25,15 @@
 import java.util.concurrent.atomic.AtomicBoolean;
 import org.neo4j.driver.BaseSession;
 import org.neo4j.driver.BookmarkManager;
+import org.neo4j.driver.BookmarkManagerConfig;
+import org.neo4j.driver.BookmarkManagers;
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.Logger;
 import org.neo4j.driver.Logging;
 import org.neo4j.driver.Metrics;
 import org.neo4j.driver.Query;
-import org.neo4j.driver.QueryConfig;
-import org.neo4j.driver.QueryTask;
+import org.neo4j.driver.ExecuteQueryConfig;
+import org.neo4j.driver.ExecuteQueryBuilder;
 import org.neo4j.driver.Session;
 import org.neo4j.driver.SessionConfig;
 import org.neo4j.driver.async.AsyncSession;
@@ -47,7 +49,7 @@
 import org.neo4j.driver.types.TypeSystem;
 
 public class InternalDriver implements Driver {
-    private final BookmarkManager queryBookmarkManager;
+    private final BookmarkManager queryBookmarkManager = BookmarkManagers.defaultManager(BookmarkManagerConfig.builder().build());
     private final SecurityPlan securityPlan;
     private final SessionFactory sessionFactory;
     private final Logger log;
@@ -56,25 +58,23 @@ public class InternalDriver implements Driver {
     private final MetricsProvider metricsProvider;
 
     InternalDriver(
-            BookmarkManager queryBookmarkManager,
             SecurityPlan securityPlan,
             SessionFactory sessionFactory,
             MetricsProvider metricsProvider,
             Logging logging) {
-        this.queryBookmarkManager = queryBookmarkManager;
         this.securityPlan = securityPlan;
         this.sessionFactory = sessionFactory;
         this.metricsProvider = metricsProvider;
         this.log = logging.getLog(getClass());
     }
 
     @Override
-    public QueryTask queryTask(String query) {
-        return new InternalQueryTask(this, new Query(query), QueryConfig.defaultConfig());
+    public ExecuteQueryBuilder executeQueryBuilder(String query) {
+        return new InternalExecuteQueryBuilder(this, new Query(query), ExecuteQueryConfig.defaultConfig());
     }
 
     @Override
-    public BookmarkManager queryTaskBookmarkManager() {
+    public BookmarkManager defaultExecuteQueryBookmarkManager() {
         return queryBookmarkManager;
     }
 

driver/src/main/java/org/neo4j/driver/internal/InternalQueryTask.java renamed to driver/src/main/java/org/neo4j/driver/internal/InternalExecuteQueryBuilder.java

@@ -24,18 +24,18 @@
 import java.util.stream.Collector;
 import org.neo4j.driver.Driver;
 import org.neo4j.driver.Query;
-import org.neo4j.driver.QueryConfig;
-import org.neo4j.driver.QueryTask;
+import org.neo4j.driver.ExecuteQueryConfig;
+import org.neo4j.driver.ExecuteQueryBuilder;
 import org.neo4j.driver.Record;
 import org.neo4j.driver.SessionConfig;
 import org.neo4j.driver.TransactionCallback;
 
-public class InternalQueryTask implements QueryTask {
+public class InternalExecuteQueryBuilder implements ExecuteQueryBuilder {
     private final Driver driver;
     private final Query query;
-    private final QueryConfig config;
+    private final ExecuteQueryConfig config;
 
-    public InternalQueryTask(Driver driver, Query query, QueryConfig config) {
+    public InternalExecuteQueryBuilder(Driver driver, Query query, ExecuteQueryConfig config) {
         requireNonNull(driver, "driver must not be null");
         requireNonNull(query, "query must not be null");
         requireNonNull(config, "config must not be null");
@@ -45,23 +45,23 @@ public InternalQueryTask(Driver driver, Query query, QueryConfig config) {
     }
 
     @Override
-    public QueryTask withParameters(Map<String, Object> parameters) {
+    public ExecuteQueryBuilder withParameters(Map<String, Object> parameters) {
         requireNonNull(parameters, "parameters must not be null");
-        return new InternalQueryTask(driver, query.withParameters(parameters), config);
+        return new InternalExecuteQueryBuilder(driver, query.withParameters(parameters), config);
     }
 
     @Override
-    public QueryTask withConfig(QueryConfig config) {
+    public ExecuteQueryBuilder withConfig(ExecuteQueryConfig config) {
         requireNonNull(config, "config must not be null");
-        return new InternalQueryTask(driver, query, config);
+        return new InternalExecuteQueryBuilder(driver, query, config);
     }
 
     @Override
     public <A, R, T> T execute(Collector<Record, A, R> recordCollector, ResultFinisher<R, T> resultFinisher) {
         var sessionConfigBuilder = SessionConfig.builder();
         config.database().ifPresent(sessionConfigBuilder::withDatabase);
         config.impersonatedUser().ifPresent(sessionConfigBuilder::withImpersonatedUser);
-        config.bookmarkManager(driver.queryTaskBookmarkManager()).ifPresent(sessionConfigBuilder::withBookmarkManager);
+        config.bookmarkManager(driver.defaultExecuteQueryBookmarkManager()).ifPresent(sessionConfigBuilder::withBookmarkManager);
         var supplier = recordCollector.supplier();
         var accumulator = recordCollector.accumulator();
         var finisher = recordCollector.finisher();
@@ -99,7 +99,7 @@ public Map<String, Object> parameters() {
     }
 
     // For testing only
-    public QueryConfig config() {
+    public ExecuteQueryConfig config() {
         return config;
     }
 }