[hibernate#1735] First changes for setOrder() support

blafond · blafond · commit aa08c5a8d7b6 · 2023-12-06T10:54:37.000-06:00
diff --git a/gradle.properties b/gradle.properties
@@ -22,11 +22,11 @@ org.gradle.java.installations.auto-download=false
 ##########################################################################
 
 # Enable Testcontainers + Docker when present (value ignored)
-#docker = true
+docker = true
 
 # The database type to use (key insensitive and support aliases):
 # Db2, MySql, PostgreSQL, CockroachDB, SqlServer, Oracle
-#db = MSSQL
+db = PostgreSQL
 
 # Enable the SonatypeOS maven repository (mainly for Vert.x snapshots) when present (value ignored)
 #enableSonatypeOpenSourceSnapshotsRep = true
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/ReactiveSelectionQuery.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/ReactiveSelectionQuery.java
@@ -22,6 +22,7 @@
 import org.hibernate.graph.spi.RootGraphImplementor;
 import org.hibernate.query.BindableType;
 import org.hibernate.query.CommonQueryContract;
+import org.hibernate.query.Order;
 import org.hibernate.query.QueryParameter;
 
 import jakarta.persistence.CacheRetrieveMode;
@@ -123,6 +124,10 @@ default CompletionStage<List<R>> getReactiveResultList() {
 
 	void applyGraph(RootGraphImplementor<?> graph, GraphSemantic semantic);
 
+	ReactiveSelectionQuery<R> setOrder(List<Order<? super R>> orderList);
+
+	ReactiveSelectionQuery<R> setOrder(Order<? super R> order);
+
 	ReactiveSelectionQuery<R> enableFetchProfile(String profileName);
 
 	@Override
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/sql/internal/ReactiveNativeQueryImpl.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/sql/internal/ReactiveNativeQueryImpl.java
@@ -29,6 +29,7 @@
 import org.hibernate.internal.AbstractSharedSessionContract;
 import org.hibernate.metamodel.model.domain.BasicDomainType;
 import org.hibernate.query.BindableType;
+import org.hibernate.query.Order;
 import org.hibernate.query.QueryParameter;
 import org.hibernate.query.ResultListTransformer;
 import org.hibernate.query.TupleTransformer;
@@ -473,6 +474,18 @@ public ReactiveNativeQueryImpl<R> setLockMode(String alias, LockMode lockMode) {
 		return this;
 	}
 
+	@Override
+	public ReactiveNativeQueryImpl<R> setOrder(List<Order<? super R>> orders) {
+		super.setOrder( orders );
+		return this;
+	}
+
+	@Override
+	public ReactiveNativeQueryImpl<R> setOrder(Order<? super R> order) {
+		super.setOrder( order );
+		return this;
+	}
+
 	@Override
 	public ReactiveNativeQueryImpl<R> setComment(String comment) {
 		super.setComment( comment );
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/sqm/ReactiveSqmSelectionQuery.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/sqm/ReactiveSqmSelectionQuery.java
@@ -9,14 +9,17 @@
 import java.util.Calendar;
 import java.util.Collection;
 import java.util.Date;
+import java.util.List;
 import java.util.Map;
 
 import org.hibernate.CacheMode;
 import org.hibernate.FlushMode;
 import org.hibernate.query.BindableType;
+import org.hibernate.query.Order;
 import org.hibernate.query.QueryParameter;
 import org.hibernate.query.spi.SqmQuery;
 import org.hibernate.reactive.query.ReactiveSelectionQuery;
+import org.hibernate.reactive.query.sqm.internal.ReactiveSqmSelectionQueryImpl;
 
 import jakarta.persistence.Parameter;
 import jakarta.persistence.TemporalType;
@@ -167,6 +170,10 @@ <P> ReactiveSqmSelectionQuery<R> setParameterList(
 	@Override
 	ReactiveSqmSelectionQuery<R> setTimeout(int timeout);
 
+	ReactiveSqmSelectionQueryImpl<R> setOrder(List<Order<? super R>> orders);
+
+	ReactiveSqmSelectionQueryImpl<R> setOrder(Order<? super R> order);
+
 	@Override
 	ReactiveSqmSelectionQuery<R> setFetchSize(int fetchSize);
 
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/sqm/internal/ReactiveQuerySqmImpl.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/sqm/internal/ReactiveQuerySqmImpl.java
@@ -35,6 +35,7 @@
 import org.hibernate.persister.entity.EntityPersister;
 import org.hibernate.query.BindableType;
 import org.hibernate.query.IllegalQueryOperationException;
+import org.hibernate.query.Order;
 import org.hibernate.query.QueryParameter;
 import org.hibernate.query.ResultListTransformer;
 import org.hibernate.query.TupleTransformer;
@@ -459,6 +460,18 @@ public ReactiveQuerySqmImpl<R> setLockMode(String alias, LockMode lockMode) {
 		return this;
 	}
 
+	@Override
+	public ReactiveQuerySqmImpl<R> setOrder(List<Order<? super R>> orders) {
+		super.setOrder( orders );
+		return this;
+	}
+
+	@Override
+	public ReactiveQuerySqmImpl<R> setOrder(Order<? super R> order) {
+		super.setOrder( order );
+		return this;
+	}
+
 	@Override
 	public <T> ReactiveQuerySqmImpl<T> setTupleTransformer(TupleTransformer<T> transformer) {
 		throw new UnsupportedOperationException();
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/sqm/internal/ReactiveSqmSelectionQueryImpl.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/query/sqm/internal/ReactiveSqmSelectionQueryImpl.java
@@ -26,6 +26,7 @@
 import org.hibernate.graph.spi.RootGraphImplementor;
 import org.hibernate.internal.util.collections.IdentitySet;
 import org.hibernate.query.BindableType;
+import org.hibernate.query.Order;
 import org.hibernate.query.QueryLogging;
 import org.hibernate.query.QueryParameter;
 import org.hibernate.query.internal.DelegatingDomainQueryExecutionContext;
@@ -251,6 +252,17 @@ public ReactiveSqmSelectionQueryImpl<R> setFollowOnLocking(boolean enable) {
 		return this;
 	}
 
+	public ReactiveSqmSelectionQueryImpl<R> setOrder(List<Order<? super R>> orders) {
+		super.setOrder( orders );
+		return this;
+	}
+
+	@Override
+	public ReactiveSqmSelectionQueryImpl<R> setOrder(Order<? super R> order) {
+		super.setOrder( order );
+		return this;
+	}
+
 	@Override
 	public ReactiveSqmSelectionQueryImpl<R> setFetchSize(int fetchSize) {
 		super.setFetchSize( fetchSize );
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/stage/Stage.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/stage/Stage.java
@@ -27,7 +27,9 @@
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
 import org.hibernate.jpa.internal.util.FlushModeTypeHelper;
 import org.hibernate.proxy.HibernateProxy;
+import org.hibernate.query.Order;
 import org.hibernate.query.Page;
+import org.hibernate.query.SelectionQuery;
 import org.hibernate.reactive.common.AffectedEntities;
 import org.hibernate.reactive.common.Identifier;
 import org.hibernate.reactive.common.ResultSetMapping;
@@ -347,6 +349,32 @@ default SelectionQuery<R> setLockMode(String alias, LockModeType lockModeType) {
 //		 */
 //		Query<R> setLockOptions(LockOptions lockOptions);
 
+		/**
+		 * If the result type of this query is an entity class, add one or more
+		 * {@linkplain Order rules} for ordering the query results.
+		 *
+		 * @param orderList one or more instances of {@link Order}
+		 *
+		 * @see Order
+		 *
+		 * @see org.hibernate.query.Query#setOrder(List)
+		 */
+		@Incubating
+		SelectionQuery<R> setOrder(List<Order<? super R>> orderList);
+
+		/**
+		 * If the result type of this query is an entity class, add a
+		 * {@linkplain Order rule} for ordering the query results.
+		 *
+		 * @param order an instance of {@link Order}
+		 *
+		 * @see Order
+		 *
+		 * @see org.hibernate.query.Query#setOrder(Order)
+		 */
+		@Incubating
+		SelectionQuery<R> setOrder(Order<? super R> order);
+
 		/**
 		 * Set the {@link EntityGraph} that will be used as a fetch plan for
 		 * the root entity returned by this query.
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/stage/impl/StageQueryImpl.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/stage/impl/StageQueryImpl.java
@@ -13,6 +13,7 @@
 import org.hibernate.LockMode;
 import org.hibernate.graph.GraphSemantic;
 import org.hibernate.graph.spi.RootGraphImplementor;
+import org.hibernate.query.Order;
 import org.hibernate.query.Page;
 import org.hibernate.reactive.query.ReactiveQuery;
 import org.hibernate.reactive.stage.Stage;
@@ -59,6 +60,18 @@ public Query<R> setLockMode(LockMode lockMode) {
 		return this;
 	}
 
+	@Override
+	public Stage.SelectionQuery<R> setOrder(List<Order<? super R>> orders) {
+		delegate.setOrder( orders );
+		return this;
+	}
+
+	@Override
+	public Stage.SelectionQuery<R> setOrder(Order<? super R> order) {
+		delegate.setOrder( (List<Order<? super R>>) order );
+		return this;
+	}
+
 	@Override
 	public Query<R> setPlan(EntityGraph<R> entityGraph) {
 		delegate.applyGraph( (RootGraphImplementor<?>) entityGraph, GraphSemantic.FETCH );
diff --git a/hibernate-reactive-core/src/main/java/org/hibernate/reactive/stage/impl/StageSelectionQueryImpl.java b/hibernate-reactive-core/src/main/java/org/hibernate/reactive/stage/impl/StageSelectionQueryImpl.java
@@ -5,6 +5,7 @@
  */
 package org.hibernate.reactive.stage.impl;
 
+import java.lang.invoke.MethodHandles;
 import java.util.List;
 import java.util.concurrent.CompletionStage;
 
@@ -13,7 +14,10 @@
 import org.hibernate.LockMode;
 import org.hibernate.graph.GraphSemantic;
 import org.hibernate.graph.spi.RootGraphImplementor;
+import org.hibernate.query.Order;
 import org.hibernate.query.Page;
+import org.hibernate.reactive.logging.impl.Log;
+import org.hibernate.reactive.logging.impl.LoggerFactory;
 import org.hibernate.reactive.query.ReactiveSelectionQuery;
 import org.hibernate.reactive.stage.Stage.SelectionQuery;
 
@@ -24,7 +28,9 @@
 import jakarta.persistence.LockModeType;
 import jakarta.persistence.Parameter;
 
+
 public class StageSelectionQueryImpl<T> implements SelectionQuery<T> {
+	private static final Log LOG = LoggerFactory.make( Log.class, MethodHandles.lookup() );
 	private final ReactiveSelectionQuery<T> delegate;
 
 	public StageSelectionQueryImpl(ReactiveSelectionQuery<T> delegate) {
@@ -188,6 +194,29 @@ public SelectionQuery<T> setLockMode(String alias, LockMode lockMode) {
 		return this;
 	}
 
+	@Override
+	public SelectionQuery<T> setOrder(List<Order<? super T>> orders) {
+		throw LOG.notYetImplemented();
+		// TODO:  see  org.hibernate.query.sqm.internal.SqmSelectQueryImpl#setOrder()
+//		sqm = sqm.copy( SqmCopyContext.noParamCopyContext() );
+//		sqm.orderBy( orderList.stream().map( order -> sortSpecification( sqm, order ) )
+//							 .collect( toList() ) );
+//		// TODO: when the QueryInterpretationCache can handle caching criteria queries,
+//		//       simply cache the new SQM as if it were a criteria query, and remove this:
+//		getQueryOptions().setQueryPlanCachingEnabled( false );
+//		return this;
+	}
+
+	@Override
+	public SelectionQuery<T> setOrder(Order<? super T> order) {
+		throw LOG.notYetImplemented();
+		// TODO:  see  org.hibernate.query.sqm.internal.SqmSelectQueryImpl#setOrder()
+//		SqmSelectStatement sqm = (SqmSelectStatement) (( SqmSelectionQuery )this).getSqmStatement().copy( SqmCopyContext.noParamCopyContext() );
+//		sqm.orderBy( (( SqmSelectionQuery )this).sortSpecification( sqm, order ) );
+//		getQueryOptions().setQueryPlanCachingEnabled( false );
+//		return this;
+	}
+
 	@Override
 	public SelectionQuery<T> setParameter(String name, Object value) {
 		delegate.setParameter( name, value );
diff --git a/hibernate-reactive-core/src/test/java/org/hibernate/reactive/orderby/OrderTest.java b/hibernate-reactive-core/src/test/java/org/hibernate/reactive/orderby/OrderTest.java
@@ -0,0 +1,102 @@
+/* Hibernate, Relational Persistence for Idiomatic Java
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * Copyright: Red Hat Inc. and Hibernate Authors
+ */
+package org.hibernate.reactive.orderby;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.concurrent.CompletionStage;
+
+import org.hibernate.metamodel.model.domain.EntityDomainType;
+import org.hibernate.metamodel.model.domain.internal.MappingMetamodelImpl;
+import org.hibernate.query.Order;
+import org.hibernate.reactive.BaseReactiveTest;
+import org.hibernate.reactive.util.impl.CompletionStages;
+
+import org.junit.jupiter.api.Test;
+
+import io.vertx.junit5.Timeout;
+import io.vertx.junit5.VertxTestContext;
+import jakarta.persistence.Entity;
+import jakarta.persistence.Id;
+import jakarta.persistence.metamodel.SingularAttribute;
+
+import static java.util.concurrent.TimeUnit.MINUTES;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+// TODO: Started this test class based on org.hibernate.orm.test.query.order.OrderTest
+// Changes required:
+//  - implement "setOrder(...)" methods for reactive session class as well as reactive SelectionQuery classes
+//  - ORM test relies on finding the "SingularAttribute" type for an element in order to call
+//  	"import static org.hibernate.query.Order.asc;"
+//		"import static org.hibernate.query.Order.desc;"
+//
+@Timeout(value = 10, timeUnit = MINUTES)
+public class OrderTest extends BaseReactiveTest {
+	final Book book1 = new Book("9781932394153", "Hibernate in Action");
+	final Book book2 = new Book("9781617290459", "Java Persistence with Hibernate");
+
+
+	@Override
+	protected Collection<Class<?>> annotatedEntities() {
+		return List.of(
+				Book.class
+		);
+	}
+
+	@Override
+	protected CompletionStage<Void> cleanDb() {
+		return CompletionStages.voidFuture();
+	}
+
+	private CompletionStage<Void> populateDB() {
+		return getSessionFactory()
+				.withTransaction( session -> session.persist( book1, book2 ) );
+	}
+
+	@Test
+	public void testOrder(VertxTestContext context) {
+		test(
+				context,
+				populateDB().thenCompose( v -> getSessionFactory()
+						.withTransaction( (session, tx) -> session
+								.createSelectionQuery( "select title from Book", String.class )
+								.getResultList()
+								.thenAccept( list -> assertTrue( list.size() == 2 ) )
+								.thenCompose( vv -> {
+									MappingMetamodelImpl metamodel = (MappingMetamodelImpl) getSessionFactory().getMetamodel();
+									EntityDomainType<Book> bookType = metamodel.getJpaMetamodel()
+											.findEntityType( Book.class );
+									SingularAttribute<? super Book, ?> title = bookType.findSingularAttribute( "title" );
+									SingularAttribute<? super Book, ?> isbn = bookType.findSingularAttribute( "isbn" );
+									return session
+											.createSelectionQuery( "from Book", Book.class )
+											.setOrder( Order.asc( title ) )
+											.getResultList();
+								} ).thenAccept( books -> {
+									assertEquals( "Hibernate in Action", books.get( 0 ).title );
+									assertEquals( "Java Persistence with Hibernate", books.get( 1 ).title );
+								} )
+						) )
+		);
+
+	}
+
+	@Entity(name="Book")
+	static class Book {
+		@Id
+		String isbn;
+		String title;
+
+		Book(String isbn, String title) {
+			this.isbn = isbn;
+			this.title = title;
+		}
+
+		Book() {
+		}
+	}
+}
diff --git a/hibernate-reactive-core/src/test/java/org/hibernate/reactive/orderby/OrderTestORM.java b/hibernate-reactive-core/src/test/java/org/hibernate/reactive/orderby/OrderTestORM.java
