GH-2239 - Resolve or remove literal replacements in custom count queries.

When executing a custom count query, the bindable parameters must be treated the exact same way like with the actual query: Literal replacement must be applied to the query or dropped.

This fixes #2239.

Author: michael-simons

src/main/java/org/springframework/data/neo4j/repository/query/StringBasedNeo4jQuery.java

@@ -37,7 +37,6 @@
 import org.springframework.data.repository.query.RepositoryQuery;
 import org.springframework.data.repository.query.SpelEvaluator;
 import org.springframework.data.repository.query.SpelQueryContext;
-import org.springframework.data.repository.query.SpelQueryContext.SpelExtractor;
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 import org.springframework.util.StringUtils;
@@ -81,6 +80,11 @@ final class StringBasedNeo4jQuery extends AbstractNeo4jQuery {
 	 */
 	private final SpelEvaluator spelEvaluator;
 
+	/**
+	 * An optional evaluator for a count query if such a query is present.
+	 */
+	private final Optional<SpelEvaluator> spelEvaluatorForCountQuery;
+
 	/**
 	 * Create a {@link StringBasedNeo4jQuery} for a query method that is annotated with {@link Query @Query}. The
 	 * annotation is expected to have a value.
@@ -156,8 +160,12 @@ private StringBasedNeo4jQuery(Neo4jOperations neo4jOperations, Neo4jMappingConte
 
 		super(neo4jOperations, mappingContext, queryMethod, queryType);
 
-		SpelExtractor spelExtractor = SPEL_QUERY_CONTEXT.parse(cypherTemplate);
-		this.spelEvaluator = new SpelEvaluator(evaluationContextProvider, queryMethod.getParameters(), spelExtractor);
+		Parameters<?, ?> methodParameters = queryMethod.getParameters();
+		this.spelEvaluator = new SpelEvaluator(
+				evaluationContextProvider, methodParameters, SPEL_QUERY_CONTEXT.parse(cypherTemplate));
+		this.spelEvaluatorForCountQuery = queryMethod.getQueryAnnotation()
+				.map(Query::countQuery)
+				.map(countQuery -> new SpelEvaluator(evaluationContextProvider, methodParameters, SPEL_QUERY_CONTEXT.parse(countQuery)));
 	}
 
 	@Override
@@ -193,7 +201,6 @@ Map<String, Object> bindParameters(Neo4jParameterAccessor parameterAccessor, boo
 		// Values from the parameter accessor can only get converted after evaluation
 		for (Entry<String, Object> evaluatedParam : spelEvaluator.evaluate(parameterAccessor.getValues()).entrySet()) {
 			Object value;
-
 			if (evaluatedParam.getValue() instanceof LiteralReplacement) {
 				value = evaluatedParam.getValue();
 			} else {
@@ -224,11 +231,22 @@ Map<String, Object> bindParameters(Neo4jParameterAccessor parameterAccessor, boo
 
 	@Override
 	protected Optional<PreparedQuery<Long>> getCountQuery(Neo4jParameterAccessor parameterAccessor) {
-
-		return queryMethod.getQueryAnnotation().map(queryAnnotation ->
-				PreparedQuery.queryFor(Long.class)
-						.withCypherQuery(queryAnnotation.countQuery())
-						.withParameters(bindParameters(parameterAccessor, false, UnaryOperator.identity())).build());
+		return spelEvaluatorForCountQuery.map(SpelEvaluator::getQueryString)
+				.map(countQuery -> {
+					Map<String, Object> boundParameters = bindParameters(parameterAccessor, false, UnaryOperator.identity());
+					QueryContext queryContext = new QueryContext(
+							queryMethod.getRepositoryName() + "." + queryMethod.getName(),
+							countQuery,
+							boundParameters
+					);
+
+					replaceLiteralsIn(queryContext);
+
+					return PreparedQuery.queryFor(Long.class)
+							.withCypherQuery(queryContext.query)
+							.withParameters(boundParameters)
+							.build();
+				});
 	}
 
 	/**

src/test/java/org/springframework/data/neo4j/integration/imperative/RepositoryIT.java

@@ -732,6 +732,24 @@ void findSliceByCustomQueryWithCountShouldWork(@Autowired PersonRepository repos
 			assertThat(slice.get()).hasSize(1).extracting("name").containsExactly(TEST_PERSON1_NAME);
 			assertThat(slice.hasNext()).isFalse();
 		}
+
+		@Test // GH-2239
+		void findPageByCustomQueryWithCountShouldWork(@Autowired PersonRepository repository) {
+
+			Page<PersonWithAllConstructor> slice = repository.findPageByCustomQueryWithCount(TEST_PERSON1_NAME, TEST_PERSON2_NAME, PageRequest.of(0, 1, Sort.by("n.name").descending()));
+			assertThat(slice.getSize()).isEqualTo(1);
+			assertThat(slice.get()).hasSize(1).extracting("name").containsExactly(TEST_PERSON2_NAME);
+			assertThat(slice.hasNext()).isTrue();
+			assertThat(slice.getTotalElements()).isEqualTo(2);
+			assertThat(slice.getTotalPages()).isEqualTo(2);
+
+			slice = repository.findPageByCustomQueryWithCount(TEST_PERSON1_NAME,  TEST_PERSON2_NAME, slice.nextPageable());
+			assertThat(slice.getSize()).isEqualTo(1);
+			assertThat(slice.get()).hasSize(1).extracting("name").containsExactly(TEST_PERSON1_NAME);
+			assertThat(slice.hasNext()).isFalse();
+			assertThat(slice.getTotalElements()).isEqualTo(2);
+			assertThat(slice.getTotalPages()).isEqualTo(2);
+		}
 	}
 
 	@Nested

src/test/java/org/springframework/data/neo4j/integration/imperative/repositories/PersonRepository.java

@@ -121,6 +121,10 @@ Optional<PersonWithAllConstructor> getOptionalPersonViaNamedQuery(@Param("part1"
 	countQuery = "MATCH (n:PersonWithAllConstructor) WHERE n.name = $aName OR n.name = $anotherName RETURN count(n)")
 	Slice<PersonWithAllConstructor> findSliceByCustomQueryWithCount(@Param("aName") String aName, @Param("anotherName") String anotherName, Pageable pageable);
 
+	@Query(value = "MATCH (n:PersonWithAllConstructor) WHERE n.name = $aName OR n.name = $anotherName RETURN n :#{orderBy(#pageable)} SKIP $skip LIMIT $limit",
+			countQuery = "MATCH (n:PersonWithAllConstructor) WHERE n.name = $aName OR n.name = $anotherName RETURN count(n)")
+	Page<PersonWithAllConstructor> findPageByCustomQueryWithCount(@Param("aName") String aName, @Param("anotherName") String anotherName, Pageable pageable);
+
 	Long countAllByNameOrName(String aName, String anotherName);
 
 	Optional<PersonWithAllConstructor> findOneByNameAndFirstNameAllIgnoreCase(String name, String firstName);