Add support for imperative CursorWindow query methods.

mp911de · mp911de · commit c9831f74f2b2 · 2023-03-01T14:26:48.000+01:00
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableFindOperation.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableFindOperation.java
@@ -20,6 +20,8 @@
 import java.util.stream.Stream;
 
 import org.springframework.dao.DataAccessException;
+import org.springframework.data.domain.CursorRequest;
+import org.springframework.data.domain.CursorWindow;
 import org.springframework.data.geo.GeoResults;
 import org.springframework.data.mongodb.core.query.CriteriaDefinition;
 import org.springframework.data.mongodb.core.query.NearQuery;
@@ -124,12 +126,19 @@ default Optional<T> first() {
 		Stream<T> stream();
 
 		/**
-		 * Get the number of matching elements.
-		 * <br />
-		 * This method uses an {@link com.mongodb.client.MongoCollection#countDocuments(org.bson.conversions.Bson, com.mongodb.client.model.CountOptions) aggregation
-		 * execution} even for empty {@link Query queries} which may have an impact on performance, but guarantees shard,
-		 * session and transaction compliance. In case an inaccurate count satisfies the applications needs use
-		 * {@link MongoOperations#estimatedCount(String)} for empty queries instead.
+		 * Return a window from a {@link CursorRequest}.
+		 *
+		 * @return a window from the resulting elements.
+		 */
+		CursorWindow<T> window(CursorRequest cursorRequest);
+
+		/**
+		 * Get the number of matching elements. <br />
+		 * This method uses an
+		 * {@link com.mongodb.client.MongoCollection#countDocuments(org.bson.conversions.Bson, com.mongodb.client.model.CountOptions)
+		 * aggregation execution} even for empty {@link Query queries} which may have an impact on performance, but
+		 * guarantees shard, session and transaction compliance. In case an inaccurate count satisfies the applications
+		 * needs use {@link MongoOperations#estimatedCount(String)} for empty queries instead.
 		 *
 		 * @return total number of matching elements.
 		 */
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableFindOperationSupport.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ExecutableFindOperationSupport.java
@@ -21,6 +21,8 @@
 
 import org.bson.Document;
 import org.springframework.dao.IncorrectResultSizeDataAccessException;
+import org.springframework.data.domain.CursorRequest;
+import org.springframework.data.domain.CursorWindow;
 import org.springframework.data.mongodb.core.query.NearQuery;
 import org.springframework.data.mongodb.core.query.Query;
 import org.springframework.data.mongodb.core.query.SerializationUtils;
@@ -138,6 +140,11 @@ public Stream<T> stream() {
 			return doStream();
 		}
 
+		@Override
+		public CursorWindow<T> window(CursorRequest cursorRequest) {
+			return template.doFindWindow(cursorRequest, query, domainType, returnType, getCollectionName());
+		}
+
 		@Override
 		public TerminatingFindNear<T> near(NearQuery nearQuery) {
 			return () -> template.geoNear(nearQuery, domainType, getCollectionName(), returnType);
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java
@@ -868,18 +868,27 @@ public <T> CursorWindow<T> findWindow(CursorRequest cursorRequest, Query query,
 	public <T> CursorWindow<T> findWindow(CursorRequest cursorRequest, Query query, Class<T> entityType,
 			String collectionName) {
 
+		return doFindWindow(cursorRequest, query, entityType, entityType, collectionName);
+	}
+
+	<T> CursorWindow<T> doFindWindow(CursorRequest cursorRequest, Query query, Class<?> sourceClass, Class<T> targetClass,
+			String collectionName) {
+
 		Assert.notNull(cursorRequest, "CursorRequest must not be null");
 		Assert.notNull(query, "Query must not be null");
 		Assert.notNull(collectionName, "CollectionName must not be null");
-		Assert.notNull(entityType, "Entity type must not be null");
+		Assert.notNull(sourceClass, "Entity type must not be null");
+		Assert.notNull(targetClass, "Target type must not be null");
 
+		ReadDocumentCallback<T> callback = new ReadDocumentCallback<>(mongoConverter, targetClass, collectionName);
 		if (cursorRequest instanceof OffsetCursorRequest offset) {
 
 			int limit = offset.getSize() + 1;
 
 			List<T> result = doFind(collectionName, createDelegate(query), query.getQueryObject(), query.getFieldsObject(),
-					entityType, new QueryCursorPreparer(query, new Query().with(cursorRequest.getSort()).getSortObject(), limit,
-							offset.getOffset(), entityType));
+					sourceClass, new QueryCursorPreparer(query, new Query().with(cursorRequest.getSort()).getSortObject(), limit,
+							offset.getOffset(), sourceClass),
+					callback);
 
 			return CursorUtils.createWindow(cursorRequest, result);
 		}
@@ -889,11 +898,11 @@ entityType, new QueryCursorPreparer(query, new Query().with(cursorRequest.getSor
 			int limit = keyset.getSize() + 1;
 
 			KeySetCursorQuery keysetPaginationQuery = CursorUtils.createKeysetPaginationQuery(query, keyset,
-					operations.getIdPropertyName(entityType));
+					operations.getIdPropertyName(sourceClass));
 
 			List<T> result = doFind(collectionName, createDelegate(query), keysetPaginationQuery.query(),
-					keysetPaginationQuery.fields(), entityType,
-					new QueryCursorPreparer(query, keysetPaginationQuery.sort(), limit, 0, entityType));
+					keysetPaginationQuery.fields(), sourceClass,
+					new QueryCursorPreparer(query, keysetPaginationQuery.sort(), limit, 0, sourceClass), callback);
 
 			return CursorUtils.createWindow(keyset, result, operations);
 		}
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/AbstractMongoQuery.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/AbstractMongoQuery.java
@@ -167,6 +167,8 @@ private MongoQueryExecution getExecution(ConvertingParameterAccessor accessor, F
 			return q -> operation.matching(q).stream();
 		} else if (method.isCollectionQuery()) {
 			return q -> operation.matching(q.with(accessor.getPageable()).with(accessor.getSort())).all();
+		} else if (method.isCursorWindowQuery()) {
+			return q -> operation.matching(q).window(accessor.getCursorRequest());
 		} else if (method.isPageQuery()) {
 			return new PagedExecution(operation, accessor.getPageable());
 		} else if (isCountQuery()) {
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/ConvertingParameterAccessor.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/ConvertingParameterAccessor.java
@@ -21,6 +21,7 @@
 import java.util.Iterator;
 import java.util.List;
 
+import org.springframework.data.domain.CursorRequest;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Range;
 import org.springframework.data.domain.Sort;
@@ -71,6 +72,11 @@ public PotentiallyConvertingIterator iterator() {
 		return new ConvertingIterator(delegate.iterator());
 	}
 
+	@Override
+	public CursorRequest getCursorRequest() {
+		return delegate.getCursorRequest();
+	}
+
 	public Pageable getPageable() {
 		return delegate.getPageable();
 	}
diff --git a/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoQueryMethod.java b/spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/MongoQueryMethod.java
@@ -335,8 +335,8 @@ public boolean hasAnnotatedCollation() {
 	public String getAnnotatedCollation() {
 
 		return doFindAnnotation(Collation.class).map(Collation::value) //
-						.orElseThrow(() -> new IllegalStateException(
-								"Expected to find @Collation annotation but did not; Make sure to check hasAnnotatedCollation() before."));
+				.orElseThrow(() -> new IllegalStateException(
+						"Expected to find @Collation annotation but did not; Make sure to check hasAnnotatedCollation() before."));
 	}
 
 	/**
@@ -420,7 +420,8 @@ public void verify() {
 
 		if (isModifyingQuery()) {
 
-			if (isCollectionQuery() || isSliceQuery() || isPageQuery() || isGeoNearQuery() || !isNumericOrVoidReturnValue()) { //
+			if (isCollectionQuery() || isCursorWindowQuery() || isSliceQuery() || isPageQuery() || isGeoNearQuery()
+					|| !isNumericOrVoidReturnValue()) { //
 				throw new IllegalStateException(
 						String.format("Update method may be void or return a numeric value (the number of updated documents)."
 								+ "Offending method: %s", method));
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/AbstractPersonRepositoryIntegrationTests.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/AbstractPersonRepositoryIntegrationTests.java
@@ -38,11 +38,12 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInstance;
 import org.junit.jupiter.api.extension.ExtendWith;
-
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.dao.DuplicateKeyException;
 import org.springframework.dao.IncorrectResultSizeDataAccessException;
+import org.springframework.data.domain.CursorWindow;
 import org.springframework.data.domain.Example;
+import org.springframework.data.domain.OffsetCursorRequest;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageRequest;
 import org.springframework.data.domain.Pageable;
@@ -208,6 +209,29 @@ void findsPagedPersons() {
 		assertThat(result).contains(dave, stefan);
 	}
 
+	@Test // GH-4308
+	void appliesCursorWindowingCorrectly() {
+
+		CursorWindow<Person> page = repository.findByLastnameLike("*a*",
+				OffsetCursorRequest.ofSize(1, Sort.by(Direction.ASC, "lastname", "firstname")));
+		assertThat(page.isFirst()).isTrue();
+		assertThat(page.isLast()).isFalse();
+		assertThat(page.size()).isEqualTo(1);
+		assertThat(page).contains(carter);
+	}
+
+	@Test // GH-4308
+	void appliesCursorWindowingWithProjectionCorrectly() {
+
+		CursorWindow<PersonSummaryDto> page = repository.findCursorProjectionByLastnameLike("*a*",
+				OffsetCursorRequest.ofSize(2, Sort.by(Direction.ASC, "lastname", "firstname")));
+		assertThat(page.isFirst()).isTrue();
+		assertThat(page.isLast()).isFalse();
+		assertThat(page.size()).isEqualTo(2);
+
+		assertThat(page).element(0).isEqualTo(new PersonSummaryDto(carter.getFirstname(), carter.getLastname()));
+	}
+
 	@Test
 	void executesPagedFinderCorrectly() {
 
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/PersonRepository.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/PersonRepository.java
@@ -23,6 +23,8 @@
 import java.util.regex.Pattern;
 import java.util.stream.Stream;
 
+import org.springframework.data.domain.CursorRequest;
+import org.springframework.data.domain.CursorWindow;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Range;
@@ -115,7 +117,26 @@ public interface PersonRepository extends MongoRepository<Person, String>, Query
 	List<Person> findByAgeLessThan(int age, Sort sort);
 
 	/**
-	 * Returns a page of {@link Person}s with a lastname mathing the given one (*-wildcards supported).
+	 * Returns a cursor window of {@link Person}s with a lastname matching the given one (*-wildcards supported).
+	 *
+	 * @param lastname
+	 * @param cursorRequest
+	 * @return
+	 */
+	CursorWindow<Person> findByLastnameLike(String lastname, CursorRequest cursorRequest);
+
+	/**
+	 * Returns a cursor window of {@link Person}s applying projections with a lastname matching the given one (*-wildcards
+	 * supported).
+	 *
+	 * @param lastname
+	 * @param cursorRequest
+	 * @return
+	 */
+	CursorWindow<PersonSummaryDto> findCursorProjectionByLastnameLike(String lastname, CursorRequest cursorRequest);
+
+	/**
+	 * Returns a page of {@link Person}s with a lastname matching the given one (*-wildcards supported).
 	 *
 	 * @param lastname
 	 * @param pageable
@@ -429,7 +450,7 @@ Person findPersonByManyArguments(String firstname, String lastname, String email
 	@Update("{ '$inc' : { 'visits' : ?1 } }")
 	int updateAllByLastname(String lastname, int increment);
 
-	@Update( pipeline = {"{ '$set' : { 'visits' : { '$add' : [ '$visits', ?1 ] } } }"})
+	@Update(pipeline = { "{ '$set' : { 'visits' : { '$add' : [ '$visits', ?1 ] } } }" })
 	void findAndIncrementVisitsViaPipelineByLastname(String lastname, int increment);
 
 	@Update("{ '$inc' : { 'visits' : ?#{[1]} } }")
diff --git a/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/PersonSummaryDto.java b/spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/PersonSummaryDto.java
@@ -15,9 +15,18 @@
  */
 package org.springframework.data.mongodb.repository;
 
+import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
+import lombok.NoArgsConstructor;
+import lombok.ToString;
+
 /**
  * @author Oliver Gierke
  */
+@EqualsAndHashCode
+@AllArgsConstructor
+@NoArgsConstructor
+@ToString
 public class PersonSummaryDto {
 
 	String firstname;
