Document that fluent findBy(…) queries must return a result.

Closes #3294

Author: mp911de

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/JpaSpecificationExecutor.java

@@ -23,6 +23,7 @@
 import java.util.Optional;
 import java.util.function.Function;
 
+import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Sort;
@@ -122,11 +123,16 @@ public interface JpaSpecificationExecutor<T> {
 	/**
 	 * Returns entities matching the given {@link Specification} applying the {@code queryFunction} that defines the query
 	 * and its result type.
+	 * <p>
+	 * The query object used with {@code queryFunction} is only valid inside the {@code findBy(…)} method call. This
+	 * requires the query function to return a query result and not the {@link FluentQuery} object itself to ensure the
+	 * query is executed inside the {@code findBy(…)} method.
 	 *
 	 * @param spec must not be null.
 	 * @param queryFunction the query function defining projection, sorting, and the result type
-	 * @return all entities matching the given Example.
+	 * @return all entities matching the given specification.
 	 * @since 3.0
+	 * @throws InvalidDataAccessApiUsageException if the query function returns the {@link FluentQuery} instance.
 	 */
 	<S extends T, R> R findBy(Specification<T> spec, Function<FluentQuery.FetchableFluentQuery<S>, R> queryFunction);
 

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/QuerydslJpaPredicateExecutor.java

@@ -24,6 +24,7 @@
 import java.util.function.Function;
 
 import org.springframework.dao.IncorrectResultSizeDataAccessException;
+import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.domain.KeysetScrollPosition;
 import org.springframework.data.domain.OffsetScrollPosition;
 import org.springframework.data.domain.Page;
@@ -40,6 +41,7 @@
 import org.springframework.data.querydsl.EntityPathResolver;
 import org.springframework.data.querydsl.QSort;
 import org.springframework.data.querydsl.QuerydslPredicateExecutor;
+import org.springframework.data.repository.query.FluentQuery;
 import org.springframework.data.repository.query.FluentQuery.FetchableFluentQuery;
 import org.springframework.data.support.PageableExecutionUtils;
 import org.springframework.lang.Nullable;
@@ -235,8 +237,7 @@ public <S extends T, R> R findBy(Predicate predicate, Function<FetchableFluentQu
 		};
 
 		FetchableFluentQueryByPredicate<T, T> fluentQuery = new FetchableFluentQueryByPredicate<>( //
-				path,
-				predicate, //
+				path, predicate, //
 				this.entityInformation, //
 				finder, //
 				scroll, //
@@ -246,7 +247,14 @@ public <S extends T, R> R findBy(Predicate predicate, Function<FetchableFluentQu
 				entityManager, //
 				getProjectionFactory());
 
-		return queryFunction.apply((FetchableFluentQuery<S>) fluentQuery);
+		R result = queryFunction.apply((FetchableFluentQuery<S>) fluentQuery);
+
+		if (result instanceof FluentQuery<?>) {
+			throw new InvalidDataAccessApiUsageException(
+					"findBy(…) queries must result a query result and not the FluentQuery object to ensure that queries are executed within the scope of the findBy(…) method");
+		}
+
+		return result;
 	}
 
 	@Override

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/support/SimpleJpaRepository.java

@@ -43,6 +43,7 @@
 import java.util.function.BiConsumer;
 import java.util.function.Function;
 
+import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.data.domain.Example;
 import org.springframework.data.domain.KeysetScrollPosition;
 import org.springframework.data.domain.OffsetScrollPosition;
@@ -66,6 +67,7 @@
 import org.springframework.data.mapping.PropertyPath;
 import org.springframework.data.projection.ProjectionFactory;
 import org.springframework.data.projection.SpelAwareProxyProjectionFactory;
+import org.springframework.data.repository.query.FluentQuery;
 import org.springframework.data.repository.query.FluentQuery.FetchableFluentQuery;
 import org.springframework.data.repository.query.ReturnedType;
 import org.springframework.data.support.PageableExecutionUtils;
@@ -542,7 +544,14 @@ private <S extends T, R> R doFindBy(Specification<T> spec, Class<T> domainClass,
 		FetchableFluentQueryBySpecification<?, T> fluentQuery = new FetchableFluentQueryBySpecification<>(spec, domainClass,
 				finder, scrollDelegate, this::count, this::exists, this.entityManager, getProjectionFactory());
 
-		return queryFunction.apply((FetchableFluentQuery<S>) fluentQuery);
+		R result = queryFunction.apply((FetchableFluentQuery<S>) fluentQuery);
+
+		if (result instanceof FluentQuery<?>) {
+			throw new InvalidDataAccessApiUsageException(
+					"findBy(…) queries must result a query result and not the FluentQuery object to ensure that queries are executed within the scope of the findBy(…) method");
+		}
+
+		return result;
 	}
 
 	@Override

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/UserRepositoryTests.java

@@ -42,6 +42,7 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
+import java.util.function.Function;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;
 
@@ -2406,6 +2407,14 @@ void findByFluentExampleWithSorting() {
 		assertThat(users).containsExactly(thirdUser, firstUser, fourthUser);
 	}
 
+	@Test // GH-3294
+	void findByFluentFailsReturningFluentQuery() {
+
+		User prototype = new User();
+		assertThatExceptionOfType(InvalidDataAccessApiUsageException.class)
+				.isThrownBy(() -> repository.findBy(of(prototype), Function.identity()));
+	}
+
 	@Test // GH-2294
 	void findByFluentExampleFirstValue() {
 
@@ -2503,13 +2512,13 @@ void findByFluentExampleWithInterfaceBasedProjectionUsingSpEL() {
 		prototype.setFirstname("v");
 
 		List<UserProjectionUsingSpEL> users = repository.findBy(
-			of(prototype,
-				matching().withIgnorePaths("age", "createdAt", "active").withMatcher("firstname",
-					GenericPropertyMatcher::contains)), //
-			q -> q.as(UserProjectionUsingSpEL.class).all());
+				of(prototype,
+						matching().withIgnorePaths("age", "createdAt", "active").withMatcher("firstname",
+								GenericPropertyMatcher::contains)), //
+				q -> q.as(UserProjectionUsingSpEL.class).all());
 
 		assertThat(users).extracting(UserProjectionUsingSpEL::hello)
-			.contains(new GreetingsFrom().groot(firstUser.getFirstname()));
+				.contains(new GreetingsFrom().groot(firstUser.getFirstname()));
 	}
 
 	@Test // GH-2294