HHH-19774 - Automatic flushing for child session with shared connection/tx

HHH-19808 - Automatic closing for child session with shared connection/tx

Author: sebersole

hibernate-core/src/main/java/org/hibernate/engine/creation/CommonSharedBuilder.java

@@ -30,6 +30,7 @@ public interface CommonSharedBuilder extends CommonBuilder {
 
 	/**
 	 * Signifies that the connection from the original session should be used to create the new session.
+	 * Implies that the overall "transaction context" should be shared as well.
 	 *
 	 * @return {@code this}, for method chaining
 	 */

hibernate-core/src/main/java/org/hibernate/engine/creation/internal/ParentSessionCallbacks.java

@@ -0,0 +1,30 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.engine.creation.internal;
+
+import org.hibernate.engine.creation.CommonSharedBuilder;
+
+/**
+ * Allows observation of flush and closure events of a parent session from a
+ * child session which shares connection/transaction with the parent.
+ *
+ * @see CommonSharedBuilder#connection()
+ *
+ * @author Steve Ebersole
+ */
+public interface ParentSessionObserver {
+	/**
+	 * Callback when the parent is flushed.  Used to flush the child session.
+	 */
+	void onParentFlush();
+
+	/**
+	 * Callback when the parent is closed.  Used to close the child session.
+	 *
+	 * @apiNote Observation of closure of the parent is different from {@link org.hibernate.SessionBuilder#autoClose}
+	 * which indicates whether the session ought to be closed in response to transaction completion.
+	 */
+	void onParentClose();
+}

hibernate-core/src/main/java/org/hibernate/engine/creation/internal/ParentSessionObserver.java

@@ -147,7 +147,7 @@ public TransactionCompletionCallbacksImplementor getTransactionCompletionCallbac
 	}
 
 	@Override
-	public void registerParentSessionCallbacks(ParentSessionCallbacks callbacks) {
+	public void registerParentSessionObserver(ParentSessionObserver callbacks) {
 		originalSession.getEventListenerManager().addListener( new SessionEventListener() {
 			@Override
 			public void flushStart() {

hibernate-core/src/main/java/org/hibernate/engine/creation/internal/SessionCreationOptionsAdaptor.java

@@ -100,6 +100,7 @@ public SessionImplementor openSession() {
 
 	@Override
 	@Deprecated(forRemoval = true)
+	@SuppressWarnings("removal")
 	public SharedSessionBuilderImplementor tenantIdentifier(String tenantIdentifier) {
 		tenantIdentifier( (Object) tenantIdentifier );
 		return this;
@@ -261,10 +262,10 @@ public SharedSessionBuilderImplementor subselectFetchEnabled(boolean subselectFe
 
 
 	@Override
-	public void registerParentSessionCallbacks(ParentSessionCallbacks callbacks) {
+	public void registerParentSessionObserver(ParentSessionObserver callbacks) {
 		original.getEventListenerManager().addListener( new SessionEventListener() {
 			@Override
-			public void flushStart() {
+			public void flushEnd(int numberOfEntities, int numberOfCollections) {
 				callbacks.onParentFlush();
 			}
 

hibernate-core/src/main/java/org/hibernate/engine/creation/internal/SharedSessionBuilderImpl.java

@@ -30,6 +30,6 @@ public interface SharedSessionCreationOptions extends SessionCreationOptions {
 	/**
 	 * Registers callbacks for the child session to integrate with events of the parent session.
 	 */
-	void registerParentSessionCallbacks(ParentSessionCallbacks callbacks);
+	void registerParentSessionObserver(ParentSessionObserver callbacks);
 
 }

hibernate-core/src/main/java/org/hibernate/engine/creation/internal/SharedSessionCreationOptions.java

@@ -27,7 +27,7 @@
 import org.hibernate.bytecode.enhance.spi.interceptor.SessionAssociationMarkers;
 import org.hibernate.cache.spi.CacheTransactionSynchronization;
 import org.hibernate.dialect.Dialect;
-import org.hibernate.engine.creation.internal.ParentSessionCallbacks;
+import org.hibernate.engine.creation.internal.ParentSessionObserver;
 import org.hibernate.engine.creation.internal.SessionCreationOptions;
 import org.hibernate.engine.creation.internal.SessionCreationOptionsAdaptor;
 import org.hibernate.engine.creation.internal.SharedSessionBuilderImpl;
@@ -225,15 +225,18 @@ public AbstractSharedSessionContract(SessionFactoryImpl factory, SessionCreation
 			jdbcSessionContext = createJdbcSessionContext( statementInspector );
 			logInconsistentOptions( sharedOptions );
 			addSharedSessionTransactionObserver( transactionCoordinator );
-			sharedOptions.registerParentSessionCallbacks( new ParentSessionCallbacks() {
+			sharedOptions.registerParentSessionObserver( new ParentSessionObserver() {
 				@Override
 				public void onParentFlush() {
 					propagateFlush();
 				}
 
 				@Override
 				public void onParentClose() {
-					propagateClose();
+					// unless explicitly disabled, propagate the closure
+					if ( sharedOptions.shouldAutoClose() ) {
+						propagateClose();
+					}
 				}
 			} );
 		}
@@ -505,13 +508,6 @@ public boolean isClosed() {
 
 	@Override
 	public void close() {
-		if ( isTransactionCoordinatorShared ) {
-			// Perform an auto-flush -
-			// This deals with the natural usage pattern of a child Session
-			// used with a try-with-resource block
-			propagateFlush();
-		}
-
 		if ( !closed || waitingForAutoClose ) {
 			try {
 				delayedAfterCompletion();
@@ -915,7 +911,7 @@ public void setNativeJdbcParametersIgnored(boolean nativeJdbcParametersIgnored)
 	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 	// dynamic HQL handling
 
-	@Override @SuppressWarnings("rawtypes")
+	@Override @Deprecated @SuppressWarnings({"rawtypes", "deprecation"})
 	public QueryImplementor createQuery(String queryString) {
 		return createQuery( queryString, null );
 	}
@@ -1017,10 +1013,12 @@ public <R> QueryImplementor<R> createQuery(TypedQueryReference<R> typedQueryRefe
 		checksBeforeQueryCreation();
 		if ( typedQueryReference instanceof SelectionSpecificationImpl<R> specification ) {
 			final var query = specification.buildCriteria( getCriteriaBuilder() );
+			//noinspection unchecked
 			return new SqmQueryImpl<>( (SqmStatement<R>) query, specification.getResultType(), this );
 		}
 		else if ( typedQueryReference instanceof MutationSpecificationImpl<?> specification ) {
 			final var query = specification.buildCriteria( getCriteriaBuilder() );
+			//noinspection unchecked
 			return new SqmQueryImpl<>( (SqmStatement<R>) query, (Class<R>) specification.getResultType(), this );
 		}
 		else {
@@ -1039,12 +1037,12 @@ else if ( typedQueryReference instanceof MutationSpecificationImpl<?> specificat
 	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 	// dynamic native (SQL) query handling
 
-	@Override
+	@Override @Deprecated @SuppressWarnings("deprecation")
 	public NativeQueryImplementor<?> createNativeQuery(String sqlString) {
 		return createNativeQuery( sqlString, (Class<?>) null );
 	}
 
-	@Override
+	@Override @Deprecated @SuppressWarnings("deprecation")
 	public NativeQueryImplementor<?> createNativeQuery(String sqlString, String resultSetMappingName) {
 		checksBeforeQueryCreation();
 		return buildNativeQuery( sqlString, resultSetMappingName, null );
@@ -1146,7 +1144,7 @@ public QueryImplementor<?> getNamedQuery(String queryName) {
 		return createNamedQuery( queryName );
 	}
 
-	@Override
+	@Override @Deprecated @SuppressWarnings("deprecation")
 	public QueryImplementor<?> createNamedQuery(String name) {
 		checksBeforeQueryCreation();
 		try {
@@ -1253,12 +1251,14 @@ protected <T,Q extends CommonQueryContract> Q buildNamedQuery(
 		// first see if it is a named HQL query
 		final var namedSqmQueryMemento = getSqmQueryMemento( queryName );
 		if ( namedSqmQueryMemento != null ) {
+			//noinspection unchecked
 			return sqmCreator.apply( (NamedSqmQueryMemento<T>) namedSqmQueryMemento );
 		}
 
 		// otherwise, see if it is a named native query
 		final var namedNativeDescriptor = getNativeQueryMemento( queryName );
 		if ( namedNativeDescriptor != null ) {
+			//noinspection unchecked
 			return nativeCreator.apply( (NamedNativeQueryMemento<T>) namedNativeDescriptor );
 		}
 
@@ -1322,7 +1322,7 @@ protected <T> SqmQueryImplementor<T> createSqmQueryImplementor(Class<T> resultTy
 		return query;
 	}
 
-	@Override
+	@Override @Deprecated @SuppressWarnings("deprecation")
 	public NativeQueryImplementor<?> getNamedNativeQuery(String queryName) {
 		final var namedNativeDescriptor = getNativeQueryMemento( queryName );
 		if ( namedNativeDescriptor != null ) {
@@ -1333,7 +1333,7 @@ public NativeQueryImplementor<?> getNamedNativeQuery(String queryName) {
 		}
 	}
 
-	@Override
+	@Override @Deprecated @SuppressWarnings("deprecation")
 	public NativeQueryImplementor<?> getNamedNativeQuery(String queryName, String resultSetMapping) {
 		final var namedNativeDescriptor = getNativeQueryMemento( queryName );
 		if ( namedNativeDescriptor != null ) {
@@ -1590,7 +1590,7 @@ public <T> QueryImplementor<T> createQuery(CriteriaQuery<T> criteriaQuery) {
 		}
 	}
 
-	@Override
+	@Override @Deprecated @SuppressWarnings("deprecation")
 	public QueryImplementor<?> createQuery(@SuppressWarnings("rawtypes") CriteriaUpdate criteriaUpdate) {
 		checkOpen();
 		try {
@@ -1602,7 +1602,7 @@ public QueryImplementor<?> createQuery(@SuppressWarnings("rawtypes") CriteriaUpd
 		}
 	}
 
-	@Override
+	@Override @Deprecated @SuppressWarnings("deprecation")
 	public QueryImplementor<?> createQuery(@SuppressWarnings("rawtypes") CriteriaDelete criteriaDelete) {
 		checkOpen();
 		try {