HHH-17620 Allow configuring filters on a stateless session

Author: marko-bekhta

hibernate-core/src/main/java/org/hibernate/Session.java

@@ -1260,37 +1260,13 @@ public interface Session extends SharedSessionContract, EntityManager {
 	 */
 	<T> NaturalIdMultiLoadAccess<T> byMultipleNaturalId(String entityName);
 
-	/**
-	 * Enable the named {@linkplain Filter filter} for this current session.
-	 * <p>
-	 * The returned {@link Filter} object must be used to bind arguments
-	 * to parameters of the filter, and every parameter must be set before
-	 * any other operation of this session is called.
-	 *
-	 * @param filterName the name of the filter to be enabled.
-	 *
-	 * @return the {@link Filter} instance representing the enabled filter.
-	 *
-	 * @throws UnknownFilterException if there is no such filter
-	 *
-	 * @see org.hibernate.annotations.FilterDef
-	 */
+	@Override
 	Filter enableFilter(String filterName);
 
-	/**
-	 * Retrieve a currently enabled {@linkplain Filter filter} by name.
-	 *
-	 * @param filterName the name of the filter to be retrieved.
-	 *
-	 * @return the {@link Filter} instance representing the enabled filter.
-	 */
+	@Override
 	Filter getEnabledFilter(String filterName);
 
-	/**
-	 * Disable the named {@linkplain Filter filter} for the current session.
-	 *
-	 * @param filterName the name of the filter to be disabled.
-	 */
+	@Override
 	void disableFilter(String filterName);
 
 	/**

hibernate-core/src/main/java/org/hibernate/SharedSessionContract.java

@@ -312,6 +312,39 @@ default <T> T doReturningWork(ReturningWork<T> work) throws HibernateException {
 	 */
 	<T> List<EntityGraph<? super T>> getEntityGraphs(Class<T> entityClass);
 
+	/**
+	 * Enable the named {@linkplain Filter filter} for this current session.
+	 * <p>
+	 * The returned {@link Filter} object must be used to bind arguments
+	 * to parameters of the filter, and every parameter must be set before
+	 * any other operation of this session is called.
+	 *
+	 * @param filterName the name of the filter to be enabled.
+	 *
+	 * @return the {@link Filter} instance representing the enabled filter.
+	 *
+	 * @throws UnknownFilterException if there is no such filter
+	 *
+	 * @see org.hibernate.annotations.FilterDef
+	 */
+	Filter enableFilter(String filterName);
+
+	/**
+	 * Retrieve a currently enabled {@linkplain Filter filter} by name.
+	 *
+	 * @param filterName the name of the filter to be retrieved.
+	 *
+	 * @return the {@link Filter} instance representing the enabled filter.
+	 */
+	Filter getEnabledFilter(String filterName);
+
+	/**
+	 * Disable the named {@linkplain Filter filter} for the current session.
+	 *
+	 * @param filterName the name of the filter to be disabled.
+	 */
+	void disableFilter(String filterName);
+
 	/**
 	 * The factory which created this session.
 	 */

hibernate-core/src/main/java/org/hibernate/engine/spi/SharedSessionDelegatorBaseImpl.java

@@ -14,6 +14,7 @@
 import org.checkerframework.checker.nullness.qual.Nullable;
 
 import org.hibernate.CacheMode;
+import org.hibernate.Filter;
 import org.hibernate.FlushMode;
 import org.hibernate.HibernateException;
 import org.hibernate.Interceptor;
@@ -651,4 +652,19 @@ public RootGraph<?> getEntityGraph(String graphName) {
 	public <T> List<EntityGraph<? super T>> getEntityGraphs(Class<T> entityClass) {
 		return delegate.getEntityGraphs( entityClass );
 	}
+
+	@Override
+	public Filter enableFilter(String filterName) {
+		return delegate.enableFilter( filterName );
+	}
+
+	@Override
+	public Filter getEnabledFilter(String filterName) {
+		return delegate.getEnabledFilter( filterName );
+	}
+
+	@Override
+	public void disableFilter(String filterName) {
+		delegate.disableFilter( filterName );
+	}
 }

hibernate-core/src/main/java/org/hibernate/internal/AbstractSharedSessionContract.java

@@ -21,6 +21,7 @@
 import jakarta.persistence.EntityGraph;
 import org.hibernate.CacheMode;
 import org.hibernate.EntityNameResolver;
+import org.hibernate.Filter;
 import org.hibernate.FlushMode;
 import org.hibernate.HibernateException;
 import org.hibernate.Interceptor;
@@ -1491,6 +1492,28 @@ public <T> List<EntityGraph<? super T>> getEntityGraphs(Class<T> entityClass) {
 		return getFactory().findEntityGraphsByType( entityClass );
 	}
 
+	// filter support ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+	@Override
+	public Filter getEnabledFilter(String filterName) {
+		pulseTransactionCoordinator();
+		return getLoadQueryInfluencers().getEnabledFilter( filterName );
+	}
+
+	@Override
+	public Filter enableFilter(String filterName) {
+		checkOpen();
+		pulseTransactionCoordinator();
+		return getLoadQueryInfluencers().enableFilter( filterName );
+	}
+
+	@Override
+	public void disableFilter(String filterName) {
+		checkOpen();
+		pulseTransactionCoordinator();
+		getLoadQueryInfluencers().disableFilter( filterName );
+	}
+
 	private void writeObject(ObjectOutputStream oos) throws IOException {
 		if ( log.isTraceEnabled() ) {
 			log.trace( "Serializing " + getClass().getSimpleName() + " [" );

hibernate-core/src/main/java/org/hibernate/internal/SessionImpl.java

@@ -1893,29 +1893,6 @@ public LoadQueryInfluencers getLoadQueryInfluencers() {
 		return loadQueryInfluencers;
 	}
 
-	// filter support ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-	@Override
-	public Filter getEnabledFilter(String filterName) {
-		pulseTransactionCoordinator();
-		return loadQueryInfluencers.getEnabledFilter( filterName );
-	}
-
-	@Override
-	public Filter enableFilter(String filterName) {
-		checkOpen();
-		pulseTransactionCoordinator();
-		return loadQueryInfluencers.enableFilter( filterName );
-	}
-
-	@Override
-	public void disableFilter(String filterName) {
-		checkOpen();
-		pulseTransactionCoordinator();
-		loadQueryInfluencers.disableFilter( filterName );
-	}
-
-
 	// fetch profile support ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 	@Override

hibernate-core/src/test/java/org/hibernate/orm/test/filter/AbstractStatefulStatelessFilterTest.java

@@ -0,0 +1,40 @@
+/*
+ * Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
+ * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ */
+package org.hibernate.orm.test.filter;
+
+import java.util.List;
+import java.util.function.BiConsumer;
+import java.util.function.Consumer;
+
+import org.hibernate.StatelessSession;
+import org.hibernate.engine.spi.SessionImplementor;
+
+import org.hibernate.testing.orm.junit.SessionFactory;
+import org.hibernate.testing.orm.junit.SessionFactoryScope;
+import org.hibernate.testing.orm.junit.SessionFactoryScopeAware;
+import org.junit.jupiter.params.provider.Arguments;
+
+@SessionFactory
+public abstract class AbstractStatefulStatelessFilterTest implements SessionFactoryScopeAware {
+
+	protected SessionFactoryScope scope;
+
+	@Override
+	public void injectSessionFactoryScope(SessionFactoryScope scope) {
+		this.scope = scope;
+	}
+
+	protected List<? extends Arguments> transactionKind() {
+		// We want to test both regular and stateless session:
+		BiConsumer<SessionFactoryScope, Consumer<SessionImplementor>> kind1 = SessionFactoryScope::inTransaction;
+		BiConsumer<SessionFactoryScope, Consumer<StatelessSession>> kind2 = SessionFactoryScope::inStatelessTransaction;
+		return List.of(
+				Arguments.of( kind1 ),
+				Arguments.of( kind2 )
+		);
+	}
+}

hibernate-core/src/test/java/org/hibernate/orm/test/filter/CriteriaQueryWithAppliedFilterTest.java

@@ -8,6 +8,9 @@
 
 import java.io.Serializable;
 import java.util.List;
+import java.util.function.BiConsumer;
+import java.util.function.Consumer;
+
 import jakarta.persistence.Column;
 import jakarta.persistence.Embeddable;
 import jakarta.persistence.Embedded;
@@ -19,6 +22,7 @@
 import jakarta.persistence.criteria.Root;
 import jakarta.persistence.criteria.Subquery;
 
+import org.hibernate.SharedSessionContract;
 import org.hibernate.annotations.Filter;
 import org.hibernate.annotations.FilterDef;
 import org.hibernate.annotations.ParamDef;
@@ -29,7 +33,8 @@
 import org.hibernate.testing.orm.junit.SessionFactoryScope;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
 
 import static org.hamcrest.core.Is.is;
 import static org.junit.Assert.assertThat;
@@ -44,12 +49,12 @@
 )
 @SessionFactory
 @TestForIssue(jiraKey = "HHH-10991")
-public class CriteriaQueryWithAppliedFilterTest {
+public class CriteriaQueryWithAppliedFilterTest extends AbstractStatefulStatelessFilterTest {
 
 	private final static Identifier STUDENT_ID = new Identifier( 2, new Identifier2( 4, 5L ) );
 
 	@BeforeEach
-	void setUP(SessionFactoryScope scope) {
+	void setUP() {
 		scope.inTransaction( session -> {
 			final Student student = new Student();
 			student.setId( STUDENT_ID );
@@ -70,20 +75,21 @@ void setUP(SessionFactoryScope scope) {
 	}
 
 	@AfterEach
-	void tearDown(SessionFactoryScope scope) {
+	void tearDown() {
 		scope.inTransaction( session -> session.createQuery( "delete from Student" ).executeUpdate() );
 	}
 
-	@Test
-	void testSubquery(SessionFactoryScope scope) {
+	@ParameterizedTest
+	@MethodSource("transactionKind")
+	void testSubquery(BiConsumer<SessionFactoryScope, Consumer<? extends SharedSessionContract>> inTransaction) {
 		final CriteriaBuilder detachedCriteriaBuilder = scope.getSessionFactory().getCriteriaBuilder();
 		final CriteriaQuery<Student> criteria = detachedCriteriaBuilder.createQuery( Student.class );
 		criteria.from( Student.class );
 		final Subquery<Integer> subquery = criteria.subquery( Integer.class );
 		final Root<Student> studentRoot = subquery.from( Student.class );
 		subquery.select( detachedCriteriaBuilder.min( studentRoot.get( "age" ) ));
 
-		scope.inTransaction( session -> {
+		inTransaction.accept( scope, session -> {
 			final CriteriaBuilder criteriaBuilder = session.getCriteriaBuilder();
 			final CriteriaQuery<Student> query = criteriaBuilder.createQuery( Student.class );
 			final Root<Student> root = query.from( Student.class );
@@ -130,8 +136,9 @@ void testSubquery(SessionFactoryScope scope) {
 	   	});
 	}
 
-	@Test
-	void testSubqueryWithRestrictionsOnComponentTypes(SessionFactoryScope scope) {
+	@ParameterizedTest
+	@MethodSource("transactionKind")
+	void testSubqueryWithRestrictionsOnComponentTypes(BiConsumer<SessionFactoryScope, Consumer<? extends SharedSessionContract>> inTransaction) {
 		final CriteriaBuilder detachedCriteriaBuilder = scope.getSessionFactory().getCriteriaBuilder();
 		final CriteriaQuery<Student> criteria = detachedCriteriaBuilder.createQuery( Student.class );
 		criteria.from( Student.class );
@@ -140,7 +147,7 @@ void testSubqueryWithRestrictionsOnComponentTypes(SessionFactoryScope scope) {
 		subquery.select( detachedCriteriaBuilder.max( studentRoot.get( "age" ) ) );
 		subquery.where( detachedCriteriaBuilder.equal( studentRoot.get( "id" ), STUDENT_ID ) );
 
-		scope.inTransaction( session -> {
+		inTransaction.accept( scope, session -> {
 			session.enableFilter( "statusFilter" ).setParameter( "status", "active" );
 
 //			final Criteria query = session.createCriteria( Student.class );
@@ -168,8 +175,9 @@ void testSubqueryWithRestrictionsOnComponentTypes(SessionFactoryScope scope) {
 		});
 	}
 
-	@Test
-	void testSubqueryWithRestrictionsOnComponentTypes2(SessionFactoryScope scope) {
+	@ParameterizedTest
+	@MethodSource("transactionKind")
+	void testSubqueryWithRestrictionsOnComponentTypes2(BiConsumer<SessionFactoryScope, Consumer<? extends SharedSessionContract>> inTransaction) {
 		final CriteriaBuilder detachedCriteriaBuilder = scope.getSessionFactory().getCriteriaBuilder();
 		final CriteriaQuery<Student> criteria = detachedCriteriaBuilder.createQuery( Student.class );
 		criteria.from( Student.class );
@@ -183,7 +191,7 @@ void testSubqueryWithRestrictionsOnComponentTypes2(SessionFactoryScope scope) {
 			)
 		);
 
-		scope.inTransaction( session -> {
+		inTransaction.accept( scope, session -> {
 			session.enableFilter( "statusFilter" ).setParameter( "status", "active" );
 
 //			final Criteria query = session.createCriteria( Student.class );
@@ -212,9 +220,10 @@ void testSubqueryWithRestrictionsOnComponentTypes2(SessionFactoryScope scope) {
 		});
 	}
 
-	@Test
-	void testRestrictionsOnComponentTypes(SessionFactoryScope scope) {
-		scope.inTransaction( session -> {
+	@ParameterizedTest
+	@MethodSource("transactionKind")
+	void testRestrictionsOnComponentTypes(BiConsumer<SessionFactoryScope, Consumer<? extends SharedSessionContract>> inTransaction) {
+		inTransaction.accept( scope, session -> {
 			session.enableFilter( "statusFilter" ).setParameter( "status", "active" );
 
 //			final Criteria query = session.createCriteria( Student.class );