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

Author: DavideD

README.md

@@ -30,20 +30,20 @@ Learn more at <http://hibernate.org/reactive>.
 
 Hibernate Reactive has been tested with:
 
-- Java 17, 21, 24
+- Java 11, 17, 21, 23
 - PostgreSQL 16
-- MySQL 9
+- MySQL 8
 - MariaDB 11
-- Db2 12
+- Db2 11
 - CockroachDB v24
 - MS SQL Server 2022
 - Oracle 23
-- [Hibernate ORM][] 7.0.0.CR1
-- [Vert.x Reactive PostgreSQL Client](https://vertx.io/docs/vertx-pg-client/java/) 4.5.14
-- [Vert.x Reactive MySQL Client](https://vertx.io/docs/vertx-mysql-client/java/) 4.5.14
-- [Vert.x Reactive Db2 Client](https://vertx.io/docs/vertx-db2-client/java/) 4.5.14
-- [Vert.x Reactive MS SQL Server Client](https://vertx.io/docs/vertx-mssql-client/java/) 4.5.14
-- [Vert.x Reactive Oracle Client](https://vertx.io/docs/vertx-oracle-client/java/) 4.5.14
+- [Hibernate ORM][] 7.0.0.CR2
+- [Vert.x Reactive PostgreSQL Client](https://vertx.io/docs/vertx-pg-client/java/) 5.0.0
+- [Vert.x Reactive MySQL Client](https://vertx.io/docs/vertx-mysql-client/java/) 5.0.0
+- [Vert.x Reactive Db2 Client](https://vertx.io/docs/vertx-db2-client/java/) 5.0.0
+- [Vert.x Reactive MS SQL Server Client](https://vertx.io/docs/vertx-mssql-client/java/) 5.0.0
+- [Vert.x Reactive Oracle Client](https://vertx.io/docs/vertx-oracle-client/java/) 5.0.0
 - [Quarkus][Quarkus] via the Hibernate Reactive extension
 
 [PostgreSQL]: https://www.postgresql.org

build.gradle

@@ -22,14 +22,21 @@ ext {
     // Example:
     // ./gradlew build -PvertxSqlClientVersion=4.0.0-SNAPSHOT
     if ( !project.hasProperty( 'vertxSqlClientVersion' ) ) {
-        vertxSqlClientVersion = '4.5.14'
+        vertxSqlClientVersion = '5.0.0'
     }
 
-    testcontainersVersion = '1.20.6'
+    testcontainersVersion = '1.20.4'
 
     logger.lifecycle "Vert.x SQL Client Version: " + project.vertxSqlClientVersion
 }
 
+// Publishing to Sonatype (Maven Central):
+nexusPublishing {
+    repositories {
+        sonatype()
+    }
+}
+
 subprojects {
     apply plugin: 'java-library'
     apply plugin: 'com.diffplug.spotless'

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

gradle.properties

@@ -40,16 +40,16 @@ hibernateOrmVersion = 7.0.0.CR2
 # Override default Hibernate ORM Gradle plugin version
 # Using the stable version because I don't know how to configure the build to download the snapshot version from
 # a remote repository
-#hibernateOrmGradlePluginVersion = 7.0.0.CR1
+#hibernateOrmGradlePluginVersion = 7.0.0.CR2
 
 # If set to true, skip Hibernate ORM version parsing (default is true, if set to null)
 # this is required when using intervals or weird versions or the build will fail
 #skipOrmVersionParsing = true
 
 # Override default Vert.x Sql client version
-#vertxSqlClientVersion = 4.5.14-SNAPSHOT
+#vertxSqlClientVersion = 5.0.0-SNAPSHOT
 
 # Override default Vert.x Web client and server versions. For integration tests, both default to vertxSqlClientVersion
-#vertxWebVersion = 4.5.14
-#vertxWebtClientVersion = 4.5.14
+#vertxWebVersion = 5.0.0
+#vertxWebtClientVersion = 5.0.0
 

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;
@@ -36,7 +36,7 @@ public void injectServices(ServiceRegistryImplementor serviceRegistry) {
 
 	@Override
 	public <T> void put(Key<T> key, T instance) {
-		final io.vertx.core.Context context = Vertx.currentContext();
+		final ContextInternal context = currentContext();
 		if ( context != null ) {
 			if ( trace ) LOG.tracef( "Putting key,value in context: [%1$s, %2$s]", key, instance );
 			context.putLocal( key, instance );
@@ -47,9 +47,13 @@ public <T> void put(Key<T> key, T instance) {
 		}
 	}
 
+	private static ContextInternal currentContext() {
+		return (ContextInternal) Vertx.currentContext();
+	}
+
 	@Override
 	public <T> T get(Key<T> key) {
-		final io.vertx.core.Context context = Vertx.currentContext();
+		final ContextInternal context = currentContext();
 		if ( context != null ) {
 			T local = context.getLocal( key );
 			if ( trace ) LOG.tracef( "Getting value %2$s from context for key %1$s", key, local  );
@@ -63,7 +67,7 @@ public <T> T get(Key<T> key) {
 
 	@Override
 	public void remove(Key<?> key) {
-		final io.vertx.core.Context context = Vertx.currentContext();
+		final ContextInternal context = currentContext();
 		if ( context != null ) {
 			boolean removed = context.removeLocal( key );
 			if ( trace ) LOG.tracef( "Key %s removed from context: %s", key, removed );
@@ -75,14 +79,15 @@ public void remove(Key<?> key) {
 
 	@Override
 	public void execute(Runnable runnable) {
-		final io.vertx.core.Context currentContext = Vertx.currentContext();
+		final io.vertx.core.Context currentContext = currentContext();
 		if ( currentContext == null ) {
 			if ( trace ) LOG.tracef( "Not in a Vert.x context, checking the VertxInstance service" );
 			final io.vertx.core.Context newContext = vertxInstance.getVertx().getOrCreateContext();
 			// Ensure we don't run on the root context, which is globally scoped:
 			// that could lead to unintentionally share the same session with other streams.
 			ContextInternal newContextInternal = (ContextInternal) newContext;
 			final ContextInternal duplicate = newContextInternal.duplicate();
+
 			if ( trace ) LOG.tracef( "Using duplicated context from VertxInstance: %s", duplicate );
 			duplicate.runOnContext( x -> runnable.run() );
 		}

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

@@ -14,9 +14,9 @@
 
 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 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

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,13 +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;
-
 /**
  * A pool of reactive connections backed by a Vert.x {@link Pool}.
  * The {@code Pool} itself is backed by an instance of {@link Vertx}
@@ -189,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.
@@ -198,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 );
 		}
 	}
 
@@ -222,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 );

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;
 
@@ -29,6 +28,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;
@@ -41,7 +41,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;
@@ -75,7 +74,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() );
@@ -217,33 +216,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) {