[#2036] Upgrade Vert.x SQL client to 5.0.0.CR4

Author: DavideD

build.gradle

@@ -22,7 +22,7 @@ ext {
     // Example:
     // ./gradlew build -PvertxSqlClientVersion=4.0.0-SNAPSHOT
     if ( !project.hasProperty( 'vertxSqlClientVersion' ) ) {
-        vertxSqlClientVersion = '4.5.12'
+        vertxSqlClientVersion = '5.0.0.CR4'
     }
 
     testcontainersVersion = '1.20.4'

documentation/src/main/asciidoc/reference/introduction.adoc

@@ -89,7 +89,7 @@ Optionally, you might also add any of the following additional features:
 | Hibernate Validator | `org.hibernate.validator:hibernate-validator` and `org.glassfish:jakarta.el`
 | Compile-time checking for your HQL queries | `org.hibernate:query-validator`
 | Second-level cache support via JCache and EHCache | `org.hibernate.orm:hibernate-jcache` along with `org.ehcache:ehcache`
-| SCRAM authentication support for PostgreSQL | `com.ongres.scram:client:2.1`
+| SCRAM authentication support for PostgreSQL | `com.ongres.scram:scram-client:3.1`
 |===
 
 You might also add the Hibernate {enhancer}[bytecode enhancer] to your

examples/native-sql-example/build.gradle

@@ -40,7 +40,7 @@ dependencies {
     runtimeOnly "org.apache.logging.log4j:log4j-core:2.20.0"
 
     // Allow authentication to PostgreSQL using SCRAM:
-    runtimeOnly 'com.ongres.scram:client:2.1'
+    runtimeOnly 'com.ongres.scram:scram-client:3.1'
 }
 
 // Optional: enable the bytecode enhancements

examples/session-example/build.gradle

@@ -41,7 +41,7 @@ dependencies {
     runtimeOnly "org.apache.logging.log4j:log4j-core:2.20.0"
 
     // Allow authentication to PostgreSQL using SCRAM:
-    runtimeOnly 'com.ongres.scram:client:2.1'
+    runtimeOnly 'com.ongres.scram:scram-client:3.1'
 }
 
 // Optional: enable the bytecode enhancements

hibernate-reactive-core/build.gradle

@@ -39,7 +39,7 @@ dependencies {
     testImplementation "io.vertx:vertx-micrometer-metrics:${vertxSqlClientVersion}"
 
     // Optional dependency of vertx-pg-client, essential when connecting via SASL SCRAM
-    testImplementation 'com.ongres.scram:client:2.1'
+    testImplementation 'com.ongres.scram:scram-client:3.1'
 
     // JUnit Jupiter
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.11.3'

hibernate-reactive-core/src/main/java/org/hibernate/reactive/context/impl/VertxContext.java

@@ -8,7 +8,7 @@
 import java.lang.invoke.MethodHandles;
 
 import io.vertx.core.Vertx;
-import io.vertx.core.impl.ContextInternal;
+import io.vertx.core.internal.ContextInternal;
 
 import org.hibernate.reactive.context.Context;
 import org.hibernate.reactive.logging.impl.Log;

hibernate-reactive-core/src/main/java/org/hibernate/reactive/id/impl/BlockingIdentifierGenerator.java

@@ -5,18 +5,18 @@
  */
 package org.hibernate.reactive.id.impl;
 
-import io.vertx.core.Context;
-import io.vertx.core.Vertx;
-import io.vertx.core.net.impl.pool.CombinerExecutor;
-import io.vertx.core.net.impl.pool.Executor;
-import io.vertx.core.net.impl.pool.Task;
+import java.util.Objects;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.CompletionStage;
 
 import org.hibernate.reactive.id.ReactiveIdentifierGenerator;
 import org.hibernate.reactive.session.ReactiveConnectionSupplier;
 
-import java.util.Objects;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.CompletionStage;
+import io.vertx.core.Context;
+import io.vertx.core.Vertx;
+import io.vertx.core.internal.pool.CombinerExecutor;
+import io.vertx.core.internal.pool.Executor;
+import io.vertx.core.internal.pool.Task;
 
 import static org.hibernate.reactive.util.impl.CompletionStages.completedFuture;
 
@@ -44,7 +44,7 @@ public abstract class BlockingIdentifierGenerator implements ReactiveIdentifierG
 	//modification access.
 	//This replaces the synchronization blocks one would see in a similar
 	//service in Hibernate ORM, but using a non-blocking cooperative design.
-	private final CombinerExecutor executor = new CombinerExecutor( state );
+	private final CombinerExecutor<GeneratorState> executor = new CombinerExecutor<>( state );
 
 	/**
 	 * Allocate a new block, by obtaining the next "hi" value from the database
@@ -138,7 +138,6 @@ public Task execute(GeneratorState state) {
 				// value in the table, so just increment the lo
 				// value and return the next id in the block
 				completedFuture( local ).whenComplete( this::acceptAsReturnValue );
-				return null;
 			}
 			else {
 				nextHiValue( connectionSupplier )
@@ -155,8 +154,8 @@ public Task execute(GeneratorState state) {
 								} );
 							}
 						} );
-				return null;
 			}
+			return null;
 		}
 
 		private void acceptAsReturnValue(final Long aLong, final Throwable throwable) {

hibernate-reactive-core/src/main/java/org/hibernate/reactive/pool/impl/DefaultSqlClientPool.java

@@ -13,6 +13,7 @@
 import java.util.ServiceConfigurationError;
 import java.util.ServiceLoader;
 import java.util.concurrent.CompletionStage;
+import java.util.function.Supplier;
 
 import org.hibernate.engine.jdbc.spi.JdbcServices;
 import org.hibernate.engine.jdbc.spi.SqlExceptionHelper;
@@ -31,14 +32,13 @@
 
 import io.vertx.core.Future;
 import io.vertx.core.Vertx;
+import io.vertx.core.net.NetClientOptions;
 import io.vertx.sqlclient.Pool;
 import io.vertx.sqlclient.PoolOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
+import io.vertx.sqlclient.impl.Utils;
 import io.vertx.sqlclient.spi.Driver;
 
-import static java.util.Collections.singletonList;
-import static java.util.stream.Collectors.toList;
-
 /**
  * A pool of reactive connections backed by a Vert.x {@link Pool}.
  * The {@code Pool} itself is backed by an instance of {@link Vertx}
@@ -190,7 +190,7 @@ protected Pool createPool(URI uri) {
 	 *
 	 * @return the new {@link Pool}
 	 */
-	protected Pool createPool(URI uri, SqlConnectOptions connectOptions, PoolOptions poolOptions, Vertx vertx) {
+	protected <T extends SqlConnectOptions> Pool createPool(URI uri, T connectOptions, PoolOptions poolOptions, Vertx vertx) {
 		try {
 			// First try to load the Pool using the standard ServiceLoader pattern
 			// This only works if exactly 1 Driver is on the classpath.
@@ -199,8 +199,9 @@ protected Pool createPool(URI uri, SqlConnectOptions connectOptions, PoolOptions
 		catch (ServiceConfigurationError e) {
 			// Backup option if multiple drivers are on the classpath.
 			// We will be able to remove this once Vertx 3.9.2 is available
-			final Driver driver = findDriver( uri, e );
-			return driver.createPool( vertx, singletonList( connectOptions ), poolOptions );
+			final Driver<SqlConnectOptions> driver = findDriver( uri, e );
+			Supplier<Future<SqlConnectOptions>> database = Utils.singletonSupplier( driver.downcast( connectOptions ) );
+			return driver.createPool( vertx, database, poolOptions, new NetClientOptions(), null );
 		}
 	}
 
@@ -223,15 +224,14 @@ protected URI jdbcUrl(Map<?,?> configurationValues) {
 	 * so we need to disambiguate according to the scheme specified
 	 * in the given {@link URI}.
 	 *
-	 * @param uri the JDBC URL or database URI
+	 * @param uri           the JDBC URL or database URI
 	 * @param originalError the error that was thrown
-	 *
 	 * @return the disambiguated {@link Driver}
 	 */
-	private Driver findDriver(URI uri, ServiceConfigurationError originalError) {
+	private Driver<SqlConnectOptions> findDriver(URI uri, ServiceConfigurationError originalError) {
 		String scheme = scheme( uri );
-		List<Driver> selected = new ArrayList<>();
-		for ( Driver d : ServiceLoader.load( Driver.class ) ) {
+		List<Driver<SqlConnectOptions>> selected = new ArrayList<>();
+		for ( Driver<SqlConnectOptions> d : ServiceLoader.load( Driver.class ) ) {
 			String driverName = d.getClass().getCanonicalName();
 			if ( matchesScheme( driverName, scheme ) ) {
 				LOG.selectedDriver( driverName );
@@ -247,7 +247,7 @@ private Driver findDriver(URI uri, ServiceConfigurationError originalError) {
 		if ( selected.size() > 1 ) {
 			List<String> driverClasses = selected.stream()
 					.map( driver -> driver.getClass().getCanonicalName() )
-					.collect( toList() );
+					.toList();
 			throw new ConfigurationException( "Multiple drivers found matching for URI scheme \"" + scheme + "\". Please, pick one: " + driverClasses, originalError );
 		}
 		return selected.get( 0 );

hibernate-reactive-core/src/test/java/org/hibernate/reactive/BaseReactiveTest.java

@@ -7,7 +7,6 @@
 
 import java.util.Collection;
 import java.util.List;
-import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionStage;
 import java.util.function.Supplier;
 
@@ -27,6 +26,7 @@
 import org.hibernate.reactive.provider.service.ReactiveGenerationTarget;
 import org.hibernate.reactive.stage.Stage;
 import org.hibernate.reactive.testing.SessionFactoryManager;
+import org.hibernate.reactive.util.impl.CompletionStages;
 import org.hibernate.tool.schema.spi.SchemaManagementTool;
 
 import org.junit.jupiter.api.AfterAll;
@@ -39,7 +39,6 @@
 import io.micrometer.core.instrument.Metrics;
 import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
 import io.smallrye.mutiny.Uni;
-import io.vertx.core.Promise;
 import io.vertx.core.VertxOptions;
 import io.vertx.junit5.RunTestOnContext;
 import io.vertx.junit5.Timeout;
@@ -73,7 +72,7 @@ public abstract class BaseReactiveTest {
 	 * Configure Vertx JUnit5 test context
 	 */
 	@RegisterExtension
-	static RunTestOnContext testOnContext = new RunTestOnContext( vertxOptions() );
+	static RunTestOnContext testOnContext = new RunTestOnContext( vertxOptions(), false );
 
 	private static VertxOptions vertxOptions() {
 		Metrics.addRegistry( new SimpleMeterRegistry() );
@@ -205,33 +204,19 @@ protected CompletionStage<Void> setupSessionFactory(Configuration configuration)
 	 * @return a {@link CompletionStage} void that succeeds when the factory is ready.
 	 */
 	protected CompletionStage<Void> setupSessionFactory(Supplier<Configuration> confSupplier) {
-		CompletableFuture<Void> future = new CompletableFuture<>();
-		testOnContext.vertx()
+		return testOnContext.vertx()
 				.executeBlocking(
 						// schema generation is a blocking operation and so it causes an
 						// exception when run on the Vert.x event loop. So call it using
 						// Vertx.executeBlocking()
-						promise -> startFactoryManager( promise, confSupplier ),
-						event -> {
-							if ( event.succeeded() ) {
-								future.complete( null );
-							}
-							else {
-								future.completeExceptionally( event.cause() );
-							}
-						}
-				);
-		return future;
-	}
-
-	private void startFactoryManager(Promise<Object> p, Supplier<Configuration> confSupplier) {
-		try {
-			factoryManager.start( () -> createHibernateSessionFactory( confSupplier.get() ) );
-			p.complete();
-		}
-		catch (Throwable e) {
-			p.fail( e );
-		}
+						() -> startFactoryManager( confSupplier ),
+						false
+				).toCompletionStage().thenCompose( CompletionStages::voidFuture );
+	}
+
+	private Object startFactoryManager(Supplier<Configuration> confSupplier) {
+		factoryManager.start( () -> createHibernateSessionFactory( confSupplier.get() ) );
+		return null;
 	}
 
 	private SessionFactory createHibernateSessionFactory(Configuration configuration) {

hibernate-reactive-core/src/test/java/org/hibernate/reactive/TenantDependentPool.java

@@ -7,16 +7,12 @@
 
 import java.net.URI;
 import java.util.Map;
-import java.util.function.Function;
 import java.util.stream.Collectors;
 
 import org.hibernate.reactive.MyCurrentTenantIdentifierResolver.Tenant;
 import org.hibernate.reactive.pool.impl.DefaultSqlClientPool;
 
-import io.vertx.core.AsyncResult;
-import io.vertx.core.Context;
 import io.vertx.core.Future;
-import io.vertx.core.Handler;
 import io.vertx.core.Vertx;
 import io.vertx.sqlclient.Pool;
 import io.vertx.sqlclient.PoolOptions;
@@ -58,8 +54,18 @@ protected Pool createPool(URI uri, SqlConnectOptions connectOptions, PoolOptions
 		return pools;
 	}
 
-	private Pool createPool(URI uri, SqlConnectOptions connectOptions, PoolOptions poolOptions, Vertx vertx, Tenant tenant) {
-		return super.createPool( changeDbName( uri, tenant ), changeDbName( connectOptions, tenant ), poolOptions, vertx );
+	private Pool createPool(
+			URI uri,
+			SqlConnectOptions connectOptions,
+			PoolOptions poolOptions,
+			Vertx vertx,
+			Tenant tenant) {
+		return super.createPool(
+				changeDbName( uri, tenant ),
+				changeDbName( connectOptions, tenant ),
+				poolOptions,
+				vertx
+		);
 	}
 
 	/**
@@ -100,11 +106,6 @@ public Pool getTenantPool(Tenant tenantId) {
 			return poolMap.get( tenantId );
 		}
 
-		@Override
-		public void getConnection(Handler<AsyncResult<SqlConnection>> handler) {
-			poolMap.get( defaultTenantId ).getConnection( handler );
-		}
-
 		@Override
 		public Future<SqlConnection> getConnection() {
 			return poolMap.get( defaultTenantId ).getConnection();
@@ -125,21 +126,6 @@ public PreparedQuery<RowSet<Row>> preparedQuery(String sql, PrepareOptions optio
 			return poolMap.get( defaultTenantId ).preparedQuery( sql, options );
 		}
 
-		@Override
-		public void close(Handler<AsyncResult<Void>> handler) {
-			poolMap.forEach( (tenant, pool) -> pool.close( handler ) );
-		}
-
-		@Override
-		public Pool connectHandler(Handler<SqlConnection> handler) {
-			return poolMap.get( defaultTenantId ).connectHandler( handler );
-		}
-
-		@Override
-		public Pool connectionProvider(Function<Context, Future<SqlConnection>> provider) {
-			return poolMap.get( defaultTenantId ).connectionProvider( provider );
-		}
-
 		@Override
 		public int size() {
 			return poolMap.get( defaultTenantId ).size();

integration-tests/bytecode-enhancements-it/build.gradle

@@ -30,7 +30,7 @@ dependencies {
     runtimeOnly "io.vertx:vertx-pg-client:${vertxSqlClientVersion}"
 
     // Allow authentication to PostgreSQL using SCRAM:
-    runtimeOnly 'com.ongres.scram:client:2.1'
+    runtimeOnly 'com.ongres.scram:scram-client:3.1'
 
     // logging
     runtimeOnly "org.apache.logging.log4j:log4j-core:${log4jVersion}"