Release version 3.1.8 (2020.0.8).

See #3617

pom.xml

@@ -5,7 +5,7 @@
 
 	<groupId>org.springframework.data</groupId>
 	<artifactId>spring-data-mongodb-parent</artifactId>
-	<version>3.1.7</version>
+	<version>3.1.8</version>
 	<packaging>pom</packaging>
 
 	<name>Spring Data MongoDB</name>
@@ -15,7 +15,7 @@
 	<parent>
 		<groupId>org.springframework.data.build</groupId>
 		<artifactId>spring-data-parent</artifactId>
-		<version>2.4.7</version>
+		<version>2.4.8</version>
 	</parent>
 
 	<modules>
@@ -26,7 +26,7 @@
 	<properties>
 		<project.type>multi</project.type>
 		<dist.id>spring-data-mongodb</dist.id>
-		<springdata.commons>2.4.7</springdata.commons>
+		<springdata.commons>2.4.8</springdata.commons>
 		<mongo>4.1.2</mongo>
 		<mongo.reactivestreams>${mongo}</mongo.reactivestreams>
 		<jmh.version>1.19</jmh.version>

spring-data-mongodb-benchmarks/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.springframework.data</groupId>
 		<artifactId>spring-data-mongodb-parent</artifactId>
-		<version>3.1.7</version>
+		<version>3.1.8</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

spring-data-mongodb-distribution/pom.xml

@@ -14,7 +14,7 @@
 	<parent>
 		<groupId>org.springframework.data</groupId>
 		<artifactId>spring-data-mongodb-parent</artifactId>
-		<version>3.1.7</version>
+		<version>3.1.8</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

spring-data-mongodb/pom.xml

@@ -11,7 +11,7 @@
 	<parent>
 		<groupId>org.springframework.data</groupId>
 		<artifactId>spring-data-mongodb-parent</artifactId>
-		<version>3.1.7</version>
+		<version>3.1.8</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/QueryMapper.java

@@ -1086,8 +1086,8 @@ public class QueryMapper {
 					removePlaceholders(DOT_POSITIONAL_PATTERN, pathExpression));
 
 			if (sourceProperty != null && sourceProperty.getOwner().equals(entity)) {
-				return mappingContext
-						.getPersistentPropertyPath(PropertyPath.from(sourceProperty.getName(), entity.getTypeInformation()));
+				return mappingContext.getPersistentPropertyPath(
+						PropertyPath.from(Pattern.quote(sourceProperty.getName()), entity.getTypeInformation()));
 			}
 
 			PropertyPath path = forName(rawPath);
@@ -1146,6 +1146,13 @@ public class QueryMapper {
 					return forName(path.substring(0, path.length() - 3) + "id");
 				}
 
+				// Ok give it another try quoting
+				try {
+					return PropertyPath.from(Pattern.quote(path), entity.getTypeInformation());
+				} catch (PropertyReferenceException | InvalidPersistentPropertyPath ex) {
+
+				}
+
 				return null;
 			}
 		}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/query/Criteria.java

@@ -20,8 +20,10 @@ import static org.springframework.util.ObjectUtils.*;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.Map.Entry;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
@@ -58,6 +60,7 @@ import com.mongodb.BasicDBList;
  * @author Christoph Strobl
  * @author Mark Paluch
  * @author Andreas Zink
+ * @author Clément Petit
  */
 public class Criteria implements CriteriaDefinition {
 
@@ -895,15 +898,15 @@ public class Criteria implements CriteriaDefinition {
 	 * @param right
 	 * @return
 	 */
-	private boolean isEqual(Object left, Object right) {
+	private boolean isEqual(@Nullable Object left, @Nullable Object right) {
 
 		if (left == null) {
 			return right == null;
 		}
 
-		if (Pattern.class.isInstance(left)) {
+		if (left instanceof Pattern) {
 
-			if (!Pattern.class.isInstance(right)) {
+			if (!(right instanceof Pattern)) {
 				return false;
 			}
 
@@ -914,6 +917,52 @@ public class Criteria implements CriteriaDefinition {
 					&& leftPattern.flags() == rightPattern.flags();
 		}
 
+		if (left instanceof Document) {
+
+			if (!(right instanceof Document)) {
+				return false;
+			}
+
+			Document leftDocument = (Document) left;
+			Document rightDocument = (Document) right;
+			Iterator<Entry<String, Object>> leftIterator = leftDocument.entrySet().iterator();
+			Iterator<Entry<String, Object>> rightIterator = rightDocument.entrySet().iterator();
+
+			while (leftIterator.hasNext() && rightIterator.hasNext()) {
+
+				Map.Entry<String, Object> leftEntry = leftIterator.next();
+				Map.Entry<String, Object> rightEntry = rightIterator.next();
+
+				if (!isEqual(leftEntry.getKey(), rightEntry.getKey())
+						|| !isEqual(leftEntry.getValue(), rightEntry.getValue())) {
+					return false;
+				}
+			}
+
+			return !leftIterator.hasNext() && !rightIterator.hasNext();
+		}
+
+		if (Collection.class.isAssignableFrom(left.getClass())) {
+
+			if (!Collection.class.isAssignableFrom(right.getClass())) {
+				return false;
+			}
+
+			Collection<?> leftCollection = (Collection<?>) left;
+			Collection<?> rightCollection = (Collection<?>) right;
+			Iterator<?> leftIterator = leftCollection.iterator();
+			Iterator<?> rightIterator = rightCollection.iterator();
+
+			while (leftIterator.hasNext() && rightIterator.hasNext()) {
+
+				if (!isEqual(leftIterator.next(), rightIterator.next())) {
+					return false;
+				}
+			}
+
+			return !leftIterator.hasNext() && !rightIterator.hasNext();
+		}
+
 		return ObjectUtils.nullSafeEquals(left, right);
 	}
 

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

@@ -33,6 +33,7 @@ import org.springframework.data.repository.query.QueryMethodEvaluationContextPro
 import org.springframework.expression.ExpressionParser;
 import org.springframework.lang.Nullable;
 import org.springframework.util.ClassUtils;
+import org.springframework.util.ObjectUtils;
 import org.springframework.util.StringUtils;
 
 /**
@@ -163,9 +164,9 @@ abstract class AggregationUtils {
 	 * @throws IllegalArgumentException when none of the above rules is met.
 	 */
 	@Nullable
-	static <T> T extractSimpleTypeResult(Document source, Class<T> targetType, MongoConverter converter) {
+	static <T> T extractSimpleTypeResult(@Nullable Document source, Class<T> targetType, MongoConverter converter) {
 
-		if (source.isEmpty()) {
+		if (ObjectUtils.isEmpty(source)) {
 			return null;
 		}
 

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/convert/QueryMapperUnitTests.java

@@ -781,7 +781,8 @@ public class QueryMapperUnitTests {
 		Query query = query(byExample(probe).and("listOfItems").exists(true));
 		org.bson.Document document = mapper.getMappedObject(query.getQueryObject(), context.getPersistentEntity(Foo.class));
 
-		assertThat(document).containsEntry("embedded\\._id", "conflux").containsEntry("my_items", new org.bson.Document("$exists", true));
+		assertThat(document).containsEntry("embedded\\._id", "conflux").containsEntry("my_items",
+				new org.bson.Document("$exists", true));
 	}
 
 	@Test // DATAMONGO-1988
@@ -1011,6 +1012,76 @@ public class QueryMapperUnitTests {
 		assertThat(target).isEqualTo(org.bson.Document.parse("{\"$text\" : { \"$search\" : \"test\" }}"));
 	}
 
+	@Test // GH-3601
+	void resolvesFieldnameWithUnderscoresCorrectly() {
+
+		Query query = query(where("fieldname_with_underscores").exists(true));
+
+		org.bson.Document document = mapper.getMappedObject(query.getQueryObject(),
+				context.getPersistentEntity(WithPropertyUsingUnderscoreInName.class));
+
+		assertThat(document)
+				.isEqualTo(new org.bson.Document("fieldname_with_underscores", new org.bson.Document("$exists", true)));
+	}
+
+	@Test // GH-3601
+	void resolvesMappedFieldnameWithUnderscoresCorrectly() {
+
+		Query query = query(where("renamed_fieldname_with_underscores").exists(true));
+
+		org.bson.Document document = mapper.getMappedObject(query.getQueryObject(),
+				context.getPersistentEntity(WithPropertyUsingUnderscoreInName.class));
+
+		assertThat(document).isEqualTo(new org.bson.Document("renamed", new org.bson.Document("$exists", true)));
+	}
+
+	@Test // GH-3601
+	void resolvesSimpleNestedFieldnameWithUnderscoresCorrectly() {
+
+		Query query = query(where("simple.fieldname_with_underscores").exists(true));
+
+		org.bson.Document document = mapper.getMappedObject(query.getQueryObject(),
+				context.getPersistentEntity(WrapperAroundWithPropertyUsingUnderscoreInName.class));
+
+		assertThat(document)
+				.isEqualTo(new org.bson.Document("simple.fieldname_with_underscores", new org.bson.Document("$exists", true)));
+	}
+
+	@Test // GH-3601
+	void resolvesSimpleNestedMappedFieldnameWithUnderscoresCorrectly() {
+
+		Query query = query(where("simple.renamed_fieldname_with_underscores").exists(true));
+
+		org.bson.Document document = mapper.getMappedObject(query.getQueryObject(),
+				context.getPersistentEntity(WrapperAroundWithPropertyUsingUnderscoreInName.class));
+
+		assertThat(document).isEqualTo(new org.bson.Document("simple.renamed", new org.bson.Document("$exists", true)));
+	}
+
+	@Test // GH-3601
+	void resolvesFieldNameWithUnderscoreOnNestedFieldnameWithUnderscoresCorrectly() {
+
+		Query query = query(where("double_underscore.fieldname_with_underscores").exists(true));
+
+		org.bson.Document document = mapper.getMappedObject(query.getQueryObject(),
+				context.getPersistentEntity(WrapperAroundWithPropertyUsingUnderscoreInName.class));
+
+		assertThat(document).isEqualTo(
+				new org.bson.Document("double_underscore.fieldname_with_underscores", new org.bson.Document("$exists", true)));
+	}
+
+	@Test // GH-3601
+	void resolvesFieldNameWithUnderscoreOnNestedMappedFieldnameWithUnderscoresCorrectly() {
+
+		Query query = query(where("double_underscore.renamed_fieldname_with_underscores").exists(true));
+
+		org.bson.Document document = mapper.getMappedObject(query.getQueryObject(),
+				context.getPersistentEntity(WrapperAroundWithPropertyUsingUnderscoreInName.class));
+
+		assertThat(document)
+				.isEqualTo(new org.bson.Document("double_underscore.renamed", new org.bson.Document("$exists", true)));
+	}
+
 	class WithDeepArrayNesting {
 
 		List<WithNestedArray> level0;
@@ -1194,4 +1265,17 @@ public class QueryMapperUnitTests {
 			this.value = value;
 		}
 	}
+
+	static class WrapperAroundWithPropertyUsingUnderscoreInName {
+
+		WithPropertyUsingUnderscoreInName simple;
+		WithPropertyUsingUnderscoreInName double_underscore;
+	}
+
+	static class WithPropertyUsingUnderscoreInName {
+
+		String fieldname_with_underscores;
+
+		@Field("renamed") String renamed_fieldname_with_underscores;
+	}
 }

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/query/CriteriaUnitTests.java

@@ -34,6 +34,8 @@ import org.springframework.data.mongodb.core.schema.MongoJsonSchema;
  * @author Thomas Darimont
  * @author Christoph Strobl
  * @author Andreas Zink
+ * @author Clément Petit
+ * @author Mark Paluch
  */
 public class CriteriaUnitTests {
 
@@ -310,9 +312,72 @@ public class CriteriaUnitTests {
 	@Test // DATAMONGO-2002
 	public void shouldEqualForSamePattern() {
 
+		Criteria left = new Criteria("field").regex("foo");
+		Criteria right = new Criteria("field").regex("foo");
+
+		assertThat(left).isEqualTo(right);
+	}
+
+	@Test // DATAMONGO-2002
+	public void shouldEqualForDocument() {
+
+		assertThat(new Criteria("field").is(new Document("one", 1).append("two", "two").append("null", null)))
+				.isEqualTo(new Criteria("field").is(new Document("one", 1).append("two", "two").append("null", null)));
+
+		assertThat(new Criteria("field").is(new Document("one", 1).append("two", "two").append("null", null)))
+				.isNotEqualTo(new Criteria("field").is(new Document("one", 1).append("two", "two")));
+
+		assertThat(new Criteria("field").is(new Document("one", 1).append("two", "two")))
+				.isNotEqualTo(new Criteria("field").is(new Document("one", 1).append("two", "two").append("null", null)));
+
+		assertThat(new Criteria("field").is(new Document("one", 1).append("null", null).append("two", "two")))
+				.isNotEqualTo(new Criteria("field").is(new Document("one", 1).append("two", "two").append("null", null)));
+
+		assertThat(new Criteria("field").is(new Document())).isNotEqualTo(new Criteria("field").is("foo"));
+		assertThat(new Criteria("field").is("foo")).isNotEqualTo(new Criteria("field").is(new Document()));
+	}
+
+	@Test // DATAMONGO-2002
+	public void shouldEqualForCollection() {
+
+		assertThat(new Criteria("field").is(Arrays.asList("foo", "bar")))
+				.isEqualTo(new Criteria("field").is(Arrays.asList("foo", "bar")));
+
+		assertThat(new Criteria("field").is(Arrays.asList("foo", 1)))
+				.isNotEqualTo(new Criteria("field").is(Arrays.asList("foo", "bar")));
+
+		assertThat(new Criteria("field").is(Collections.singletonList("foo")))
+				.isNotEqualTo(new Criteria("field").is(Arrays.asList("foo", "bar")));
+
+		assertThat(new Criteria("field").is(Arrays.asList("foo", "bar")))
+				.isNotEqualTo(new Criteria("field").is(Collections.singletonList("foo")));
+
+		assertThat(new Criteria("field").is(Arrays.asList("foo", "bar"))).isNotEqualTo(new Criteria("field").is("foo"));
+
+		assertThat(new Criteria("field").is("foo")).isNotEqualTo(new Criteria("field").is(Arrays.asList("foo", "bar")));
+	}
+
+	@Test // GH-3414
+	public void shouldEqualForSamePatternAndFlags() {
+
 		Criteria left = new Criteria("field").regex("foo", "iu");
 		Criteria right = new Criteria("field").regex("foo");
 
 		assertThat(left).isNotEqualTo(right);
 	}
+
+	@Test // GH-3414
+	public void shouldEqualForNestedPattern() {
+
+		Criteria left = new Criteria("a").orOperator(
+			new Criteria("foo").regex("value", "i"),
+			new Criteria("bar").regex("value")
+		);
+		Criteria right = new Criteria("a").orOperator(
+			new Criteria("foo").regex("value", "i"),
+			new Criteria("bar").regex("value")
+		);
+
+		assertThat(left).isEqualTo(right);
+	}
 }

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

@@ -159,6 +159,14 @@ public class StringBasedAggregationUnitTests {
 		assertThat(executeAggregation("returnCollection").result).isEqualTo(expected);
 	}
 
+	@Test // GH-3623
+	public void returnNullWhenSingleResultIsNotPresent() {
+
+		when(aggregationResults.getMappedResults()).thenReturn(Collections.emptyList());
+
+		assertThat(executeAggregation("simpleReturnType").result).isNull();
+	}
+
 	@Test // DATAMONGO-2153
 	public void returnRawResultType() {
 		assertThat(executeAggregation("returnRawResultType").result).isEqualTo(aggregationResults);
@@ -312,6 +320,9 @@ public class StringBasedAggregationUnitTests {
 
 		@Aggregation(RAW_GROUP_BY_LASTNAME_STRING)
 		Page<Person> invalidPageReturnType(Pageable page);
+
+		@Aggregation(RAW_GROUP_BY_LASTNAME_STRING)
+		String simpleReturnType();
 	}
 
 	static class PersonAggregate {

src/main/resources/changelog.txt

@@ -1,6 +1,20 @@
 Spring Data MongoDB Changelog
 =============================
 
+Changes in version 3.1.8 (2021-04-14)
+-------------------------------------
+* #3623 - `@Aggregation` repository query method causes `NullPointerException` when the result is empty.
+* #3601 - Criteria object not allowing to use field names with underscore in them.
+* #3414 - Criteria or toEquals fail if contains regex [DATAMONGO-2559].
+
+
+Changes in version 3.0.9.RELEASE (2021-04-14)
+---------------------------------------------
+* #3623 - `@Aggregation` repository query method causes `NullPointerException` when the result is empty.
+* #3609 - SimpleReactiveMongoRepository#saveAll does not populate @Id property if it is immutable.
+* #3414 - Criteria or toEquals fail if contains regex [DATAMONGO-2559].
+
+
 Changes in version 3.1.7 (2021-03-31)
 -------------------------------------
 * #3613 - Use StringUtils.replace(…) instead of String.replaceAll(…) for mapKeyDotReplacement.
@@ -3402,6 +3416,8 @@ Repository
 
 
 
+
+
 
 
 

src/main/resources/notice.txt

@@ -1,4 +1,4 @@
-Spring Data MongoDB 3.1.7 (2020.0.7)
+Spring Data MongoDB 3.1.8 (2020.0.8)
 Copyright (c) [2010-2019] Pivotal Software, Inc.
 
 This product is licensed to you under the Apache License, Version 2.0 (the "License").
@@ -27,3 +27,4 @@ conditions of the subcomponent's license, as noted in the LICENSE file.
 
 
 
+