DATAMONGO-600 - Fixed parameter binding for derived queries on properties using polymorphism.

We need to retain the type in the serialized DBObject in case a derived query binds parameters for properties that use polymorphism as we serialize the object as nested document and this only matches in an all-or-nothing way. So if the type information is missing, we won't see any results.

So we now hand the TypeInformation of the property into the conversion logic and transparently skip the type information removal in case the types differ.

Author: odrotbohm

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

@@ -1,19 +1,18 @@
 /*
- * Copyright (c) 2011 by the original author(s).
+ * Copyright 2011-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 package org.springframework.data.mongodb.core.convert;
 
 import java.math.BigInteger;
@@ -33,8 +32,8 @@
  * Base class for {@link MongoConverter} implementations. Sets up a {@link GenericConversionService} and populates basic
  * converters. Allows registering {@link CustomConversions}.
  * 
- * @author Jon Brisbin <jbrisbin@vmware.com>
- * @author Oliver Gierke ogierke@vmware.com
+ * @author Jon Brisbin
+ * @author Oliver Gierke
  */
 public abstract class AbstractMongoConverter implements MongoConverter, InitializingBean {
 
@@ -94,6 +93,14 @@ private void initializeConverters() {
 		conversions.registerConvertersIn(conversionService);
 	}
 
+	/* 
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.convert.MongoWriter#convertToMongoType(java.lang.Object)
+	 */
+	public Object convertToMongoType(Object obj) {
+		return convertToMongoType(obj, null);
+	}
+
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.core.core.convert.MongoConverter#getConversionService()

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2012 by the original author(s).
+ * Copyright 2011-2013 by the original author(s).
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -816,8 +816,12 @@ protected <T> List<?> unwrapList(BasicDBList dbList, TypeInformation<T> targetTy
 		return rootList;
 	}
 
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.convert.MongoWriter#convertToMongoType(java.lang.Object, org.springframework.data.util.TypeInformation)
+	 */
 	@SuppressWarnings("unchecked")
-	public Object convertToMongoType(Object obj) {
+	public Object convertToMongoType(Object obj, TypeInformation<?> typeInformation) {
 
 		if (obj == null) {
 			return null;
@@ -864,7 +868,12 @@ public Object convertToMongoType(Object obj) {
 
 		DBObject newDbo = new BasicDBObject();
 		this.write(obj, newDbo);
-		return removeTypeInfoRecursively(newDbo);
+
+		if (typeInformation == null) {
+			return removeTypeInfoRecursively(newDbo);
+		}
+
+		return !obj.getClass().equals(typeInformation.getType()) ? newDbo : removeTypeInfoRecursively(newDbo);
 	}
 
 	public BasicDBList maybeConvertList(Iterable<?> source) {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2012 the original author or authors.
+ * Copyright 2010-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@
 
 import org.springframework.data.convert.EntityWriter;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
+import org.springframework.data.util.TypeInformation;
 
 import com.mongodb.DBObject;
 import com.mongodb.DBRef;
@@ -35,11 +36,21 @@ public interface MongoWriter<T> extends EntityWriter<T, DBObject> {
 	 * Converts the given object into one Mongo will be able to store natively. If the given object can already be stored
 	 * as is, no conversion will happen.
 	 * 
-	 * @param obj
+	 * @param obj can be {@literal null}.
 	 * @return
 	 */
 	Object convertToMongoType(Object obj);
 
+	/**
+	 * Converts the given object into one Mongo will be able to store natively but retains the type information in case
+	 * the given {@link TypeInformation} differs from the given object type.
+	 * 
+	 * @param obj can be {@literal null}.
+	 * @param typeInformation can be {@literal null}.
+	 * @return
+	 */
+	Object convertToMongoType(Object obj, TypeInformation<?> typeInformation);
+
 	/**
 	 * Creates a {@link DBRef} to refer to the given object.
 	 * 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011 the original author or authors.
+ * Copyright 2011-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -28,6 +28,7 @@
 import org.springframework.data.mongodb.core.geo.Point;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
 import org.springframework.data.repository.query.ParameterAccessor;
+import org.springframework.data.util.TypeInformation;
 import org.springframework.util.Assert;
 import org.springframework.util.CollectionUtils;
 
@@ -85,12 +86,12 @@ public Sort getSort() {
 		return delegate.getSort();
 	}
 
-	/* (non-Javadoc)
-	  * @see org.springframework.data.repository.query.ParameterAccessor#getBindableParameter(int)
-	  */
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.repository.query.ParameterAccessor#getBindableValue(int)
+	 */
 	public Object getBindableValue(int index) {
-
-		return getConvertedValue(delegate.getBindableValue(index));
+		return getConvertedValue(delegate.getBindableValue(index), null);
 	}
 
 	/*
@@ -101,7 +102,8 @@ public Distance getMaxDistance() {
 		return delegate.getMaxDistance();
 	}
 
-	/* (non-Javadoc)
+	/* 
+	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.repository.MongoParameterAccessor#getGeoNearLocation()
 	 */
 	public Point getGeoNearLocation() {
@@ -111,11 +113,12 @@ public Point getGeoNearLocation() {
 	/**
 	 * Converts the given value with the underlying {@link MongoWriter}.
 	 * 
-	 * @param value
+	 * @param value can be {@literal null}.
+	 * @param typeInformation can be {@literal null}.
 	 * @return
 	 */
-	private Object getConvertedValue(Object value) {
-		return writer.convertToMongoType(value);
+	private Object getConvertedValue(Object value, TypeInformation<?> typeInformation) {
+		return writer.convertToMongoType(value, typeInformation == null ? null : typeInformation.getActualType());
 	}
 
 	/* 
@@ -186,7 +189,7 @@ public Object nextConverted(MongoPersistentProperty property) {
 				}
 			}
 
-			return getConvertedValue(next);
+			return getConvertedValue(next, property.getTypeInformation());
 		}
 
 		/*

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011 the original author or authors.
+ * Copyright 2011-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@
 import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentProperty;
 import org.springframework.data.mongodb.core.query.NearQuery;
+import org.springframework.data.util.TypeInformation;
 
 import com.mongodb.BasicDBObject;
 import com.mongodb.DBObject;
@@ -78,7 +79,7 @@ public MappingContext<? extends MongoPersistentEntity<?>, MongoPersistentPropert
 				return null;
 			}
 
-			public Object convertToMongoType(Object obj) {
+			public Object convertToMongoType(Object obj, TypeInformation<?> typeInformation) {
 				return null;
 			}
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2012 the original author or authors.
+ * Copyright 2011-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -523,4 +523,23 @@ public void executesAndQueryCorrectly() {
 		assertThat(result, hasSize(1));
 		assertThat(result, hasItem(oliver));
 	}
+
+	/**
+	 * @see DATAMONGO-600
+	 */
+	@Test
+	public void readsDocumentsWithNestedPolymorphismCorrectly() {
+
+		UsernameAndPassword usernameAndPassword = new UsernameAndPassword();
+		usernameAndPassword.username = "dave";
+		usernameAndPassword.password = "btcs";
+
+		dave.credentials = usernameAndPassword;
+
+		repository.save(dave);
+
+		List<Person> result = repository.findByCredentials(usernameAndPassword);
+		assertThat(result, hasSize(1));
+		assertThat(result, hasItem(dave));
+	}
 }

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

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2013 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.mongodb.repository;
+
+/**
+ *
+ * @author Oliver Gierke
+ */
+public interface Credentials {
+
+}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2011 the original author or authors.
+ * Copyright 2010-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -54,6 +54,8 @@ public enum Sex {
 	@DBRef
 	User creator;
 
+	Credentials credentials;
+
 	public Person() {
 
 		this(null, null);

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2012 the original author or authors.
+ * Copyright 2010-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -192,4 +192,10 @@ public interface PersonRepository extends MongoRepository<Person, String>, Query
 	 */
 	List<Person> findByLastnameNot(String lastname);
 
+	/**
+	 * @see DATAMONGO-600
+	 * @param credentials
+	 * @return
+	 */
+	List<Person> findByCredentials(Credentials credentials);
 }

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

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2013 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.mongodb.repository;
+
+/**
+ * @author Oliver Gierke
+ */
+public class UsernameAndPassword implements Credentials {
+
+	String username;
+	String password;
+}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011-2012 the original author or authors.
+ * Copyright 2011-2013 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -49,6 +49,7 @@
 import org.springframework.data.repository.Repository;
 import org.springframework.data.repository.core.support.DefaultRepositoryMetadata;
 import org.springframework.data.repository.query.parser.PartTree;
+import org.springframework.data.util.TypeInformation;
 
 /**
  * Unit test for {@link MongoQueryCreator}.
@@ -74,7 +75,7 @@ public void setUp() throws SecurityException, NoSuchMethodException {
 			public Object answer(InvocationOnMock invocation) throws Throwable {
 				return invocation.getArguments()[0];
 			}
-		}).when(converter).convertToMongoType(any());
+		}).when(converter).convertToMongoType(any(), Mockito.any(TypeInformation.class));
 	}
 
 	@Test