Introduce ability to wrap an Hibernate ORM core Dialect

Sanne · DavideD · commit 8375a3becb52 · 2023-03-02T13:56:35.000Z
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/dialect/ReactiveDialectWrapper.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/dialect/ReactiveDialectWrapper.java
@@ -5,11 +5,10 @@
  */
 package org.hibernate.reactive.dialect;
 
-import org.hibernate.dialect.DatabaseVersion;
+import org.hibernate.dialect.Dialect;
+import org.hibernate.dialect.DialectDelegateWrapper;
 import org.hibernate.dialect.PostgreSQLDialect;
-import org.hibernate.dialect.PostgreSQLDriverKind;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
-import org.hibernate.engine.jdbc.dialect.spi.DialectResolutionInfo;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.metamodel.mapping.EntityMappingType;
 import org.hibernate.metamodel.spi.RuntimeModelCreationContext;
@@ -25,28 +24,34 @@
 import org.hibernate.sql.ast.tree.Statement;
 import org.hibernate.sql.exec.spi.JdbcOperation;
 
-public class ReactivePostgreSQLDialect extends PostgreSQLDialect {
+/**
+ * Wraps the given dialect to make some internal components reactive;
+ * also, potentially applies a SQL syntax workaround if the wrapped Dialect
+ * is extending PostgreSQLDialect.
+ */
+public final class ReactiveDialectWrapper extends DialectDelegateWrapper {
 
-	public ReactivePostgreSQLDialect() {
-		this( DatabaseVersion.make( 10 ) );
-	}
+	//FIXME remove PostgreSQLDialect specific workarounds after HHH-16229
+	private final boolean requiresPostgreSQLSyntaxProcessing;
 
-	public ReactivePostgreSQLDialect(DialectResolutionInfo info) {
-		super( info, PostgreSQLDriverKind.OTHER );
-	}
-
-	public ReactivePostgreSQLDialect(DatabaseVersion version) {
-		super( version, PostgreSQLDriverKind.OTHER );
+	public ReactiveDialectWrapper(Dialect wrapped) {
+		super( wrapped );
+		this.requiresPostgreSQLSyntaxProcessing = ( wrapped instanceof PostgreSQLDialect );
 	}
 
 	@Override
 	public SqlAstTranslatorFactory getSqlAstTranslatorFactory() {
-		return new StandardSqlAstTranslatorFactory() {
-			@Override
-			protected <T extends JdbcOperation> SqlAstTranslator<T> buildTranslator(SessionFactoryImplementor sessionFactory, Statement statement) {
-				return new ReactivePostgreSQLSqlAstTranslator<>( sessionFactory, statement );
-			}
-		};
+		if ( requiresPostgreSQLSyntaxProcessing ) {
+			return new StandardSqlAstTranslatorFactory() {
+				@Override
+				protected <T extends JdbcOperation> SqlAstTranslator<T> buildTranslator(SessionFactoryImplementor sessionFactory, Statement statement) {
+					return new ReactivePostgreSQLSqlAstTranslator<>( sessionFactory, statement );
+				}
+			};
+		}
+		else {
+			return wrapped.getSqlAstTranslatorFactory();
+		}
 	}
 
 	@Override
@@ -63,4 +68,5 @@ public SqmMultiTableMutationStrategy getFallbackSqmMutationStrategy(EntityMappin
 	public SqmMultiTableInsertStrategy getFallbackSqmInsertStrategy(EntityMappingType rootEntityDescriptor, RuntimeModelCreationContext runtimeModelCreationContext) {
 		return new ReactiveCteInsertStrategy( rootEntityDescriptor, runtimeModelCreationContext );
 	}
+
 }
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/impl/ReactiveServiceInitiators.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/impl/ReactiveServiceInitiators.java
@@ -16,7 +16,6 @@
 import org.hibernate.engine.config.internal.ConfigurationServiceInitiator;
 import org.hibernate.engine.jdbc.batch.internal.BatchBuilderInitiator;
 import org.hibernate.engine.jdbc.cursor.internal.RefCursorSupportInitiator;
-import org.hibernate.engine.jdbc.dialect.internal.DialectFactoryInitiator;
 import org.hibernate.engine.jdbc.dialect.internal.DialectResolverInitiator;
 import org.hibernate.engine.jdbc.internal.JdbcServicesInitiator;
 import org.hibernate.engine.jndi.internal.JndiServiceInitiator;
@@ -32,6 +31,7 @@
 import org.hibernate.reactive.provider.service.NoJdbcEnvironmentInitiator;
 import org.hibernate.reactive.provider.service.NoJdbcMultiTenantConnectionProviderInitiator;
 import org.hibernate.reactive.provider.service.NoJtaPlatformInitiator;
+import org.hibernate.reactive.provider.service.ReactiveDialectFactoryInitiator;
 import org.hibernate.reactive.provider.service.ReactiveMarkerServiceInitiator;
 import org.hibernate.reactive.provider.service.ReactivePersisterClassResolverInitiator;
 import org.hibernate.reactive.provider.service.ReactiveSchemaManagementToolInitiator;
@@ -101,7 +101,9 @@ private static List<StandardServiceInitiator<?>> buildInitialServiceInitiatorLis
 		serviceInitiators.add( NoJdbcMultiTenantConnectionProviderInitiator.INSTANCE );
 
 		serviceInitiators.add( DialectResolverInitiator.INSTANCE );
-		serviceInitiators.add( DialectFactoryInitiator.INSTANCE );
+
+		//Custom for Hibernate Reactive:
+		serviceInitiators.add( ReactiveDialectFactoryInitiator.INSTANCE );
 		serviceInitiators.add( BatchBuilderInitiator.INSTANCE );
 		serviceInitiators.add( JdbcServicesInitiator.INSTANCE );
 		serviceInitiators.add( RefCursorSupportInitiator.INSTANCE );
@@ -124,6 +126,7 @@ private static List<StandardServiceInitiator<?>> buildInitialServiceInitiatorLis
 		serviceInitiators.add( ManagedBeanRegistryInitiator.INSTANCE );
 		serviceInitiators.add( EntityCopyObserverFactoryInitiator.INSTANCE );
 
+		//Custom for Hibernate Reactive:
 		serviceInitiators.add( ReactiveValuesMappingProducerProviderInitiator.INSTANCE );
 
 		serviceInitiators.trimToSize();
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/service/NoJdbcEnvironmentInitiator.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/service/NoJdbcEnvironmentInitiator.java
@@ -17,6 +17,7 @@
 import org.hibernate.dialect.MariaDBDialect;
 import org.hibernate.dialect.MySQLDialect;
 import org.hibernate.dialect.OracleDialect;
+import org.hibernate.dialect.PostgreSQLDialect;
 import org.hibernate.dialect.SQLServerDialect;
 import org.hibernate.engine.jdbc.connections.spi.ConnectionProvider;
 import org.hibernate.engine.jdbc.connections.spi.JdbcConnectionAccess;
@@ -25,7 +26,6 @@
 import org.hibernate.engine.jdbc.env.internal.JdbcEnvironmentInitiator;
 import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
 import org.hibernate.internal.util.config.ConfigurationHelper;
-import org.hibernate.reactive.dialect.ReactivePostgreSQLDialect;
 import org.hibernate.reactive.engine.jdbc.env.internal.ReactiveJdbcEnvironment;
 import org.hibernate.reactive.logging.impl.Log;
 import org.hibernate.reactive.logging.impl.LoggerFactory;
@@ -132,7 +132,7 @@ protected Class<? extends Dialect> guessDialect(String url) {
 			return MariaDBDialect.class;
 		}
 		if ( url.startsWith( "postgresql:" ) || url.startsWith( "postgres:" ) ) {
-			return ReactivePostgreSQLDialect.class;
+			return PostgreSQLDialect.class;
 		}
 		if ( url.startsWith( "db2:" ) ) {
 			return DB2Dialect.class;
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/service/ReactiveDialectFactoryInitiator.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/service/ReactiveDialectFactoryInitiator.java
@@ -0,0 +1,29 @@
+/* Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.reactive.provider.service;
+
+import java.util.Map;
+
+import org.hibernate.boot.registry.StandardServiceInitiator;
+import org.hibernate.engine.jdbc.dialect.spi.DialectFactory;
+import org.hibernate.service.spi.ServiceRegistryImplementor;
+
+public class ReactiveDialectFactoryInitiator  implements StandardServiceInitiator<DialectFactory> {
+	/**
+	 * Singleton access
+	 */
+	public static final ReactiveDialectFactoryInitiator INSTANCE = new ReactiveDialectFactoryInitiator();
+
+	@Override
+	public Class<DialectFactory> getServiceInitiated() {
+		return DialectFactory.class;
+	}
+
+	@Override
+	public DialectFactory initiateService(Map<String, Object> configurationValues, ServiceRegistryImplementor registry) {
+		return new ReactiveWrappingDialectFactory();
+	}
+}
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/service/ReactiveSchemaManagementTool.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/service/ReactiveSchemaManagementTool.java
@@ -9,6 +9,7 @@
 import org.hibernate.boot.model.relational.SqlStringGenerationContext;
 import org.hibernate.dialect.CockroachDialect;
 import org.hibernate.dialect.Dialect;
+import org.hibernate.dialect.DialectDelegateWrapper;
 import org.hibernate.dialect.MariaDBDialect;
 import org.hibernate.dialect.MySQLDialect;
 import org.hibernate.dialect.OracleDialect;
@@ -58,7 +59,12 @@ public ExtractionContext createExtractionContext(
 		}
 
 		public InformationExtractor createInformationExtractor(ExtractionContext extractionContext) {
-			final Dialect dialect = extractionContext.getJdbcEnvironment().getDialect();
+			Dialect dialect = extractionContext.getJdbcEnvironment().getDialect();
+			//Allow for wrapped cases:
+			if ( dialect instanceof DialectDelegateWrapper ) {
+				dialect = ( (DialectDelegateWrapper) dialect ).getWrappedDialect();
+			}
+			//Now detect the kind of Dialect:
 			if ( dialect instanceof PostgreSQLDialect || dialect instanceof CockroachDialect ) {
 				return new PostgreSqlReactiveInformationExtractorImpl( extractionContext );
 			}
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/service/ReactiveWrappingDialectFactory.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/provider/service/ReactiveWrappingDialectFactory.java
@@ -0,0 +1,43 @@
+/* Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.reactive.provider.service;
+
+import java.util.Map;
+
+import org.hibernate.HibernateException;
+import org.hibernate.dialect.Dialect;
+import org.hibernate.engine.jdbc.dialect.internal.DialectFactoryImpl;
+import org.hibernate.engine.jdbc.dialect.spi.DialectFactory;
+import org.hibernate.engine.jdbc.dialect.spi.DialectResolutionInfoSource;
+import org.hibernate.reactive.dialect.ReactiveDialectWrapper;
+import org.hibernate.service.spi.ServiceRegistryAwareService;
+import org.hibernate.service.spi.ServiceRegistryImplementor;
+
+public class ReactiveWrappingDialectFactory implements DialectFactory, ServiceRegistryAwareService {
+
+	private final DialectFactoryImpl original = new DialectFactoryImpl();
+
+	@Override
+	public Dialect buildDialect(Map<String, Object> configValues, DialectResolutionInfoSource resolutionInfoSource)
+			throws HibernateException {
+		return wrap( original.buildDialect( configValues, resolutionInfoSource ) );
+	}
+
+	private Dialect wrap(final Dialect dialect) {
+		if ( dialect == null ) {
+			return null;
+		}
+		else {
+			return new ReactiveDialectWrapper( dialect );
+		}
+	}
+
+	@Override
+	public void injectServices(ServiceRegistryImplementor serviceRegistry) {
+		original.injectServices( serviceRegistry );
+	}
+
+}
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/sql/ast/spi/ReactivePostgreSQLSqlAstTranslator.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/sql/ast/spi/ReactivePostgreSQLSqlAstTranslator.java
@@ -8,49 +8,15 @@
 import org.hibernate.dialect.PostgreSQLSqlAstTranslator;
 import org.hibernate.engine.spi.SessionFactoryImplementor;
 import org.hibernate.reactive.pool.impl.PostgresParameters;
-import org.hibernate.reactive.sql.results.internal.ReactiveStandardValuesMappingProducer;
 import org.hibernate.sql.ast.tree.Statement;
-import org.hibernate.sql.ast.tree.select.SelectStatement;
 import org.hibernate.sql.exec.spi.JdbcOperation;
-import org.hibernate.sql.exec.spi.JdbcOperationQuerySelect;
-
-import static org.hibernate.sql.ast.SqlTreePrinter.logSqlAst;
-import static org.hibernate.sql.results.graph.DomainResultGraphPrinter.logDomainResultGraph;
 
 public class ReactivePostgreSQLSqlAstTranslator<T extends JdbcOperation> extends PostgreSQLSqlAstTranslator<T> {
 
-	private int paramCounter = 0;
-
 	public ReactivePostgreSQLSqlAstTranslator(SessionFactoryImplementor sessionFactory, Statement statement) {
 		super( sessionFactory, statement );
 	}
 
-	@Override
-	protected JdbcOperationQuerySelect translateSelect(SelectStatement selectStatement) {
-		logDomainResultGraph( selectStatement.getDomainResultDescriptors() );
-		logSqlAst( selectStatement );
-
-		visitSelectStatement( selectStatement );
-
-		final int rowsToSkip;
-		return new JdbcOperationQuerySelect(
-				getSql(),
-				getParameterBinders(),
-				new ReactiveStandardValuesMappingProducer(
-						selectStatement.getQuerySpec().getSelectClause().getSqlSelections(),
-						selectStatement.getDomainResultDescriptors()
-				),
-				getAffectedTableNames(),
-				getFilterJdbcParameters(),
-				rowsToSkip = getRowsToSkip( selectStatement, getJdbcParameterBindings() ),
-				getMaxRows( selectStatement, getJdbcParameterBindings(), rowsToSkip ),
-				getAppliedParameterBindings(),
-				getJdbcLockStrategy(),
-				getOffsetParameter(),
-				getLimitParameter()
-		);
-	}
-
 	@Override
 	public String getSql() {
 		// Not all queries goes through the appendSql
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/sql/ast/spi/ReactiveSqlAstTranslator.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/sql/ast/spi/ReactiveSqlAstTranslator.java
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/sql/ast/spi/ReactiveStandardSqlAstTranslatorFactory.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/sql/ast/spi/ReactiveStandardSqlAstTranslatorFactory.java
