introduce PreFlushEvent

gavinking · gavinking · commit 119cd8b00ae5 · 2025-11-19T14:46:32.000+01:00
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionDelegatorBaseImpl.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SessionDelegatorBaseImpl.java
@@ -60,6 +60,7 @@
 import org.hibernate.query.criteria.HibernateCriteriaBuilder;
 import org.hibernate.query.criteria.JpaCriteriaInsert;
 import org.hibernate.query.spi.QueryImplementor;
+import org.hibernate.query.spi.QueryParameterBindings;
 import org.hibernate.query.spi.QueryProducerImplementor;
 import org.hibernate.query.sql.spi.NativeQueryImplementor;
 import org.hibernate.resource.jdbc.spi.JdbcSessionContext;
@@ -418,8 +419,8 @@ public boolean autoFlushIfRequired(Set<String> querySpaces, boolean skipPreFlush
 	}
 
 	@Override
-	public void autoPreFlush(Set<String> querySpaces) {
-		delegate.autoPreFlush( querySpaces );
+	public boolean autoPreFlushIfRequired(QueryParameterBindings parameterBindings) {
+		return delegate.autoPreFlushIfRequired( parameterBindings );
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionContractImplementor.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionContractImplementor.java
@@ -29,6 +29,7 @@
 import org.hibernate.engine.jdbc.spi.JdbcCoordinator;
 import org.hibernate.engine.jdbc.spi.JdbcServices;
 import org.hibernate.persister.entity.EntityPersister;
+import org.hibernate.query.spi.QueryParameterBindings;
 import org.hibernate.query.spi.QueryProducerImplementor;
 import org.hibernate.resource.jdbc.spi.JdbcSessionOwner;
 import org.hibernate.resource.transaction.spi.TransactionCoordinator;
@@ -535,7 +536,7 @@ default boolean autoFlushIfRequired(Set<String> querySpaces) {
 	 */
 	boolean autoFlushIfRequired(Set<String> querySpaces, boolean skipPreFlush);
 
-	void autoPreFlush(Set<String> querySpaces);
+	boolean autoPreFlushIfRequired(QueryParameterBindings parameterBindings);
 
 	/**
 	 * Check if there is a Hibernate or JTA transaction in progress and,
diff --git a/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionDelegatorBaseImpl.java b/hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionDelegatorBaseImpl.java
@@ -40,6 +40,7 @@
 import org.hibernate.query.criteria.HibernateCriteriaBuilder;
 import org.hibernate.query.criteria.JpaCriteriaInsert;
 import org.hibernate.query.spi.QueryImplementor;
+import org.hibernate.query.spi.QueryParameterBindings;
 import org.hibernate.query.spi.QueryProducerImplementor;
 import org.hibernate.query.sql.spi.NativeQueryImplementor;
 import org.hibernate.resource.jdbc.spi.JdbcSessionContext;
@@ -569,8 +570,8 @@ public boolean autoFlushIfRequired(Set<String> querySpaces, boolean skipPreFlush
 	}
 
 	@Override
-	public void autoPreFlush(Set<String> querySpaces) {
-		delegate.autoPreFlush( querySpaces );
+	public boolean autoPreFlushIfRequired(QueryParameterBindings parameterBindings) {
+		return delegate.autoPreFlushIfRequired( parameterBindings );
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultAutoFlushEventListener.java b/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultAutoFlushEventListener.java
@@ -81,12 +81,12 @@ public void onAutoFlush(AutoFlushEvent event) throws HibernateException {
 		}
 	}
 
-	static boolean flushIsReallyNeeded(AutoFlushEvent event, EventSource source) {
+	private static boolean flushIsReallyNeeded(AutoFlushEvent event, EventSource source) {
 		return source.getHibernateFlushMode() == FlushMode.ALWAYS
 			|| source.getActionQueue().areTablesToBeUpdated( event.getQuerySpaces() );
 	}
 
-	static boolean flushMightBeNeeded(AutoFlushEvent event, EventSource source) {
+	private static boolean flushMightBeNeeded(AutoFlushEvent event, EventSource source) {
 		return flushMightBeNeededForMode( event, source )
 			&& nonEmpty( source );
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultPreFlushEventListener.java b/hibernate-core/src/main/java/org/hibernate/event/internal/DefaultPreFlushEventListener.java
@@ -5,21 +5,22 @@
 package org.hibernate.event.internal;
 
 import org.hibernate.HibernateException;
-import org.hibernate.event.spi.AutoFlushEvent;
+import org.hibernate.event.spi.EventSource;
+import org.hibernate.event.spi.PreFlushEvent;
 import org.hibernate.event.spi.PreFlushEventListener;
 
-import static org.hibernate.event.internal.DefaultAutoFlushEventListener.flushMightBeNeeded;
-
 public class DefaultPreFlushEventListener extends AbstractFlushingEventListener implements PreFlushEventListener {
+
 	@Override
-	public void onAutoPreFlush(AutoFlushEvent event) throws HibernateException {
+	public void onAutoPreFlush(PreFlushEvent event) throws HibernateException {
 		final var source = event.getEventSource();
 		final var eventListenerManager = source.getEventListenerManager();
 		eventListenerManager.prePartialFlushStart();
 		final var eventMonitor = source.getEventMonitor();
 		final var diagnosticEvent = eventMonitor.beginPrePartialFlush();
 		try {
-			if ( flushMightBeNeeded( event, source ) ) {
+			if ( preFlushMightBeNeeded( source )
+					&& event.getParameterBindings().hasAnyTransientEntityBindings( source ) ) {
 				preFlush( source, source.getPersistenceContextInternal() );
 			}
 		}
@@ -28,4 +29,23 @@ public void onAutoPreFlush(AutoFlushEvent event) throws HibernateException {
 			eventListenerManager.prePartialFlushEnd();
 		}
 	}
+
+
+	private static boolean preFlushMightBeNeeded(EventSource source) {
+		return flushMightBeNeededForMode( source )
+			&& nonEmpty( source );
+	}
+
+	private static boolean flushMightBeNeededForMode(EventSource source) {
+		return switch ( source.getHibernateFlushMode() ) {
+			case ALWAYS, AUTO -> true;
+			case MANUAL, COMMIT -> false;
+		};
+	}
+
+	private static boolean nonEmpty(EventSource source) {
+		final var persistenceContext = source.getPersistenceContextInternal();
+		return persistenceContext.getNumberOfManagedEntities() > 0
+			|| persistenceContext.getCollectionEntriesSize() > 0;
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/event/spi/PreFlushEvent.java b/hibernate-core/src/main/java/org/hibernate/event/spi/PreFlushEvent.java
@@ -0,0 +1,41 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.event.spi;
+
+import org.hibernate.Incubating;
+import org.hibernate.query.spi.QueryParameterBindings;
+
+/**
+ * An event that occurs just before arguments are bound to JDBC
+ * parameters during execution of HQL. Gives Hibernate a chance
+ * to persist any transient entities used as query parameter
+ * arguments.
+ *
+ * @author Gavin King
+ * @since 7.2
+ */
+@Incubating
+public class PreFlushEvent extends AbstractSessionEvent {
+
+	private boolean preFlushRequired;
+	private final QueryParameterBindings parameterBindings;
+
+	public PreFlushEvent(QueryParameterBindings parameterBindings, EventSource source) {
+		super( source );
+		this.parameterBindings = parameterBindings;
+	}
+
+	public QueryParameterBindings getParameterBindings() {
+		return parameterBindings;
+	}
+
+	public boolean isPreFlushRequired() {
+		return preFlushRequired;
+	}
+
+	public void setPreFlushRequired(boolean preFlushRequired) {
+		this.preFlushRequired = preFlushRequired;
+	}
+}
diff --git a/hibernate-core/src/main/java/org/hibernate/event/spi/PreFlushEventListener.java b/hibernate-core/src/main/java/org/hibernate/event/spi/PreFlushEventListener.java
@@ -5,11 +5,15 @@
 package org.hibernate.event.spi;
 
 import org.hibernate.HibernateException;
+import org.hibernate.Incubating;
 
 /**
+ * A listener for events of type {@link PreFlushEvent}.
+ *
  * @author Gavin King
  * @since 7.2
  */
+@Incubating
 public interface PreFlushEventListener {
-	void onAutoPreFlush(AutoFlushEvent event) throws HibernateException;
+	void onAutoPreFlush(PreFlushEvent event) throws HibernateException;
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/SessionImpl.java b/hibernate-core/src/main/java/org/hibernate/internal/SessionImpl.java
@@ -61,6 +61,7 @@
 import org.hibernate.query.SelectionQuery;
 import org.hibernate.query.UnknownSqlResultSetMappingException;
 import org.hibernate.query.spi.QueryImplementor;
+import org.hibernate.query.spi.QueryParameterBindings;
 import org.hibernate.resource.jdbc.spi.JdbcSessionOwner;
 import org.hibernate.resource.transaction.spi.TransactionCoordinator;
 import org.hibernate.resource.transaction.spi.TransactionCoordinatorBuilder;
@@ -1437,15 +1438,17 @@ public boolean autoFlushIfRequired(Set<String> querySpaces, boolean skipPreFlush
 	}
 
 	@Override
-	public void autoPreFlush(Set<String> querySpaces) {
+	public boolean autoPreFlushIfRequired(QueryParameterBindings parameterBindings) {
 		checkOpen();
-		// do not auto-flush while outside a transaction
-		if ( isTransactionInProgress() ) {
-			final var autoFlushEvent = new AutoFlushEvent( querySpaces, false, this );
-			eventListenerGroups.eventListenerGroup_PRE_FLUSH
-					.fireEventOnEachListener( autoFlushEvent,
-							PreFlushEventListener::onAutoPreFlush );
+		if ( !isTransactionInProgress() ) {
+			// do not auto-flush while outside a transaction
+			return false;
 		}
+		final var preFlushEvent = new PreFlushEvent( parameterBindings, this );
+		eventListenerGroups.eventListenerGroup_PRE_FLUSH
+				.fireEventOnEachListener( preFlushEvent,
+						PreFlushEventListener::onAutoPreFlush );
+		return preFlushEvent.isPreFlushRequired();
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/internal/StatelessSessionImpl.java b/hibernate-core/src/main/java/org/hibernate/internal/StatelessSessionImpl.java
@@ -69,6 +69,7 @@
 import org.hibernate.loader.internal.CacheLoadHelper;
 import org.hibernate.persister.collection.CollectionPersister;
 import org.hibernate.persister.entity.EntityPersister;
+import org.hibernate.query.spi.QueryParameterBindings;
 import org.hibernate.stat.spi.StatisticsImplementor;
 
 import java.util.List;
@@ -1325,7 +1326,8 @@ public void afterScrollOperation() {
 	}
 
 	@Override
-	public void autoPreFlush(Set<String> querySpaces) {
+	public boolean autoPreFlushIfRequired(QueryParameterBindings parameterBindings) {
+		return false;
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/procedure/internal/ProcedureParamBindings.java b/hibernate-core/src/main/java/org/hibernate/procedure/internal/ProcedureParamBindings.java
@@ -121,7 +121,7 @@ public boolean hasAnyMultiValuedBindings() {
 	}
 
 	@Override
-	public boolean hasAnyTransientEntityBindings(SharedSessionContractImplementor factory) {
+	public boolean hasAnyTransientEntityBindings(SharedSessionContractImplementor session) {
 		return false;
 	}
 
@@ -131,7 +131,7 @@ public void visitBindings(BiConsumer<? super QueryParameter<?>, ? super QueryPar
 	}
 
 	@Override
-	public QueryKey.ParameterBindingsMemento generateQueryKeyMemento(SharedSessionContractImplementor persistenceContext) {
+	public QueryKey.ParameterBindingsMemento generateQueryKeyMemento(SharedSessionContractImplementor session) {
 		return NO_PARAMETER_BINDING_MEMENTO;
 	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/query/spi/QueryParameterBindings.java b/hibernate-core/src/main/java/org/hibernate/query/spi/QueryParameterBindings.java
@@ -76,13 +76,13 @@ default <P> QueryParameterBinding<P> getBinding(QueryParameter<P> parameter) {
 
 	boolean hasAnyMultiValuedBindings();
 
-	boolean hasAnyTransientEntityBindings(SharedSessionContractImplementor factory);
+	boolean hasAnyTransientEntityBindings(SharedSessionContractImplementor session);
 
 	/**
 	 * Generate a "memento" for these parameter bindings that can be used
 	 * in creating a {@link QueryKey}
 	 */
-	QueryKey.ParameterBindingsMemento generateQueryKeyMemento(SharedSessionContractImplementor persistenceContext);
+	QueryKey.ParameterBindingsMemento generateQueryKeyMemento(SharedSessionContractImplementor session);
 
 	void visitBindings(BiConsumer<? super QueryParameter<?>, ? super QueryParameterBinding<?>> action);
 
@@ -130,7 +130,7 @@ public boolean hasAnyMultiValuedBindings() {
 		}
 
 		@Override
-		public boolean hasAnyTransientEntityBindings(SharedSessionContractImplementor factory) {
+		public boolean hasAnyTransientEntityBindings(SharedSessionContractImplementor session) {
 			return false;
 		}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/ConcreteSqmSelectQueryPlan.java b/hibernate-core/src/main/java/org/hibernate/query/sqm/internal/ConcreteSqmSelectQueryPlan.java
@@ -364,12 +364,8 @@ public ScrollableResultsImplementor<R> performScroll(ScrollMode scrollMode, Doma
 
 	private <T, X> T withCacheableSqmInterpretation(DomainQueryExecutionContext executionContext, X context, SqmInterpreter<T, X> interpreter) {
 		final var session = executionContext.getSession();
-		final boolean preFlush =
-				executionContext.getQueryParameterBindings()
-						.hasAnyTransientEntityBindings( session );
-		if ( preFlush ) {
-			session.autoPreFlush( null );
-		}
+
+		final boolean preFlushed = session.autoPreFlushIfRequired( executionContext.getQueryParameterBindings() );
 
 		// IMPORTANT NOTE: Intentional double-lock checking
 		// Another solution would be to use ReadWriteLock
@@ -428,7 +424,7 @@ private <T, X> T withCacheableSqmInterpretation(DomainQueryExecutionContext exec
 			jdbcParameterBindings = createJdbcParameterBindings( localCopy, executionContext );
 		}
 
-		return interpreter.interpret( context, executionContext, localCopy, jdbcParameterBindings, preFlush );
+		return interpreter.interpret( context, executionContext, localCopy, jdbcParameterBindings, preFlushed );
 	}
 
 	// For Hibernate Reactive

Original file line number	Diff line number	Diff line change
`@@ -81,12 +81,12 @@ public void onAutoFlush(AutoFlushEvent event) throws HibernateException {`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`
`84`		`- static boolean flushIsReallyNeeded(AutoFlushEvent event, EventSource source) {`
	`84`	`+ private static boolean flushIsReallyNeeded(AutoFlushEvent event, EventSource source) {`
`85`	`85`	`return source.getHibernateFlushMode() == FlushMode.ALWAYS`
`86`	`86`	`\|\| source.getActionQueue().areTablesToBeUpdated( event.getQuerySpaces() );`
`87`	`87`	`}`
`88`	`88`
`89`		`- static boolean flushMightBeNeeded(AutoFlushEvent event, EventSource source) {`
	`89`	`+ private static boolean flushMightBeNeeded(AutoFlushEvent event, EventSource source) {`
`90`	`90`	`return flushMightBeNeededForMode( event, source )`
`91`	`91`	`&& nonEmpty( source );`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,7 @@`
`69`	`69`	`import org.hibernate.loader.internal.CacheLoadHelper;`
`70`	`70`	`import org.hibernate.persister.collection.CollectionPersister;`
`71`	`71`	`import org.hibernate.persister.entity.EntityPersister;`
	`72`	`+import org.hibernate.query.spi.QueryParameterBindings;`
`72`	`73`	`import org.hibernate.stat.spi.StatisticsImplementor;`
`73`	`74`
`74`	`75`	`import java.util.List;`
`@@ -1325,7 +1326,8 @@ public void afterScrollOperation() {`
`1325`	`1326`	`}`
`1326`	`1327`
`1327`	`1328`	`@Override`
`1328`		`- public void autoPreFlush(Set<String> querySpaces) {`
	`1329`	`+ public boolean autoPreFlushIfRequired(QueryParameterBindings parameterBindings) {`
	`1330`	`+ return false;`
`1329`	`1331`	`}`
`1330`	`1332`
`1331`	`1333`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -121,7 +121,7 @@ public boolean hasAnyMultiValuedBindings() {`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	`@Override`
`124`		`- public boolean hasAnyTransientEntityBindings(SharedSessionContractImplementor factory) {`
	`124`	`+ public boolean hasAnyTransientEntityBindings(SharedSessionContractImplementor session) {`
`125`	`125`	`return false;`
`126`	`126`	`}`
`127`	`127`
`@@ -131,7 +131,7 @@ public void visitBindings(BiConsumer<? super QueryParameter<?>, ? super QueryPar`
`131`	`131`	`}`
`132`	`132`
`133`	`133`	`@Override`
`134`		`- public QueryKey.ParameterBindingsMemento generateQueryKeyMemento(SharedSessionContractImplementor persistenceContext) {`
	`134`	`+ public QueryKey.ParameterBindingsMemento generateQueryKeyMemento(SharedSessionContractImplementor session) {`
`135`	`135`	`return NO_PARAMETER_BINDING_MEMENTO;`
`136`	`136`	`}`
`137`	`137`	`}`