DATAMONGO-1603 - Fix Placeholder not replaced correctly in @query.

Fix issues when placeholders are appended with other chars eg. '?0xyz' or have been reused multiple times within the query.

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/ExpressionEvaluatingParameterBinder.java

@@ -247,7 +247,7 @@ private Pattern createReplacementPattern(List<ParameterBinding> bindings) {
 
 			regex.append("|");
 			regex.append("(" + Pattern.quote(binding.getParameter()) + ")");
-			regex.append("(\\W?['\"])?"); // potential quotation char (as in { foo : '?0' }).
+			regex.append("(\\W?['\"]|\\w*')?");
 		}
 
 		return Pattern.compile(regex.substring(1));
@@ -271,9 +271,16 @@ private Placeholder extractPlaceholder(int parameterIndex, Matcher matcher) {
 			if (!StringUtils.hasText(rawPlaceholder)) {
 
 				rawPlaceholder = matcher.group();
-				suffix = "" + rawPlaceholder.charAt(rawPlaceholder.length() - 1);
+				if(rawPlaceholder.matches(".*\\d$")) {
+					suffix = "";
+				} else {
+					int index = rawPlaceholder.replaceAll("[^\\?a-zA-Z0-9]*$", "").length() - 1;
+					if(index > 1) {
+						suffix = rawPlaceholder.substring(index);
+					}
+				}
 				if (QuotedString.endsWithQuote(rawPlaceholder)) {
-					rawPlaceholder = QuotedString.unquoteSuffix(rawPlaceholder);
+					rawPlaceholder = rawPlaceholder.substring(0, rawPlaceholder.length() - (StringUtils.hasText(suffix) ? suffix.length() : 1));
 				}
 			}
 
@@ -284,6 +291,7 @@ private Placeholder extractPlaceholder(int parameterIndex, Matcher matcher) {
 				return Placeholder.of(parameterIndex, rawPlaceholder, quoted,
 						quoted ? QuotedString.unquoteSuffix(suffix) : suffix);
 			}
+			return Placeholder.of(parameterIndex, rawPlaceholder, false, null);
 		}
 
 		return Placeholder.of(parameterIndex, matcher.group(), false, null);

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/query/StringBasedMongoQuery.java

@@ -339,8 +339,7 @@ private static void potentiallyAddBinding(String source, List<ParameterBinding>
 			while (valueMatcher.find()) {
 
 				int paramIndex = Integer.parseInt(valueMatcher.group(PARAMETER_INDEX_GROUP));
-				boolean quoted = (source.startsWith("'") && source.endsWith("'"))
-						|| (source.startsWith("\"") && source.endsWith("\""));
+				boolean quoted = source.startsWith("'") || source.startsWith("\"");
 
 				bindings.add(new ParameterBinding(paramIndex, quoted));
 			}

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/repository/query/StringBasedMongoQueryUnitTests.java

@@ -437,6 +437,54 @@ public void shouldReplaceParametersInInQuotedExpressionOfNestedQueryOperator() t
 		assertThat(query.getQueryObject(), is((DBObject) new BasicDBObject("lastname", Pattern.compile("^(calamity)"))));
 	}
 
+	@Test // DATAMONGO-1603
+	public void shouldAllowReuseOfPlaceholderWithinQuery() throws Exception {
+
+		StringBasedMongoQuery mongoQuery = createQueryForMethod("findByReusingPlaceholdersMultipleTimes", String.class,
+				String.class);
+		ConvertingParameterAccessor accessor = StubParameterAccessor.getAccessor(converter, "calamity", "regalia");
+
+		org.springframework.data.mongodb.core.query.Query query = mongoQuery.createQuery(accessor);
+		assertThat(query.getQueryObject(), is((DBObject) new BasicDBObject().append("arg0", "calamity")
+				.append("arg1", "regalia").append("arg2", "calamity")));
+	}
+
+	@Test // DATAMONGO-1603
+	public void shouldAllowReuseOfQuotedPlaceholderWithinQuery() throws Exception {
+
+		StringBasedMongoQuery mongoQuery = createQueryForMethod("findByReusingPlaceholdersMultipleTimesWhenQuoted",
+				String.class, String.class);
+		ConvertingParameterAccessor accessor = StubParameterAccessor.getAccessor(converter, "calamity", "regalia");
+
+		org.springframework.data.mongodb.core.query.Query query = mongoQuery.createQuery(accessor);
+		assertThat(query.getQueryObject(), is((DBObject) new BasicDBObject().append("arg0", "calamity")
+				.append("arg1", "regalia").append("arg2", "calamity")));
+	}
+
+	@Test // DATAMONGO-1603
+	public void shouldAllowReuseOfQuotedPlaceholderWithinQueryAndIncludeSuffixCorrectly() throws Exception {
+
+		StringBasedMongoQuery mongoQuery = createQueryForMethod(
+				"findByReusingPlaceholdersMultipleTimesWhenQuotedAndSomeStuffAppended", String.class, String.class);
+		ConvertingParameterAccessor accessor = StubParameterAccessor.getAccessor(converter, "calamity", "regalia");
+
+		org.springframework.data.mongodb.core.query.Query query = mongoQuery.createQuery(accessor);
+		assertThat(query.getQueryObject(), is((DBObject) new BasicDBObject().append("arg0", "calamity")
+				.append("arg1", "regalia").append("arg2", "calamitys")));
+	}
+
+	@Test // DATAMONGO-1603
+	public void shouldAllowQuotedParameterWithSuffixAppended() throws Exception {
+
+		StringBasedMongoQuery mongoQuery = createQueryForMethod("findByWhenQuotedAndSomeStuffAppended", String.class,
+				String.class);
+		ConvertingParameterAccessor accessor = StubParameterAccessor.getAccessor(converter, "calamity", "regalia");
+
+		org.springframework.data.mongodb.core.query.Query query = mongoQuery.createQuery(accessor);
+		assertThat(query.getQueryObject(),
+				is((DBObject) new BasicDBObject().append("arg0", "calamity").append("arg1", "regalias")));
+	}
+
 	private StringBasedMongoQuery createQueryForMethod(String name, Class<?>... parameters) throws Exception {
 
 		Method method = SampleRepository.class.getMethod(name, parameters);
@@ -510,5 +558,17 @@ private interface SampleRepository extends Repository<Person, Long> {
 
 		@Query("{ 'arg0' : ?0 }")
 		List<Person> findByWithBsonArgument(DBObject arg0);
+
+		@Query("{ 'arg0' : ?0, 'arg1' : ?1, 'arg2' : ?0 }")
+		List<Person> findByReusingPlaceholdersMultipleTimes(String arg0, String arg1);
+
+		@Query("{ 'arg0' : ?0, 'arg1' : ?1, 'arg2' : '?0' }")
+		List<Person> findByReusingPlaceholdersMultipleTimesWhenQuoted(String arg0, String arg1);
+
+		@Query("{ 'arg0' : '?0', 'arg1' : ?1, 'arg2' : '?0s' }")
+		List<Person> findByReusingPlaceholdersMultipleTimesWhenQuotedAndSomeStuffAppended(String arg0, String arg1);
+
+		@Query("{ 'arg0' : '?0', 'arg1' : '?1s' }")
+		List<Person> findByWhenQuotedAndSomeStuffAppended(String arg0, String arg1);
 	}
 }