DATAMONGO-1393 - Fix ValidatingMongoEventListener when using lazy proxies.

ValidatingMongoEventListener checks now whether the validated object is a lazy-loading proxy. In such a case the proxy is unwrapped and the validation is performed with the underlying target object.

Original pull request: #350.
CLA: 168220160322083905 (Paul Sterl)

Author: Paul Sterl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/mapping/event/ValidatingMongoEventListener.java

@@ -22,6 +22,7 @@
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.data.mongodb.core.convert.LazyLoadingProxy;
 import org.springframework.util.Assert;
 
 import com.mongodb.DBObject;
@@ -31,6 +32,8 @@
  * before entities are saved in database.
  * 
  * @author Maciej Walkowiak
+ * @author Oliver Gierke
+ * @author Paul Sterl
  */
 public class ValidatingMongoEventListener extends AbstractMongoEventListener<Object> {
 
@@ -57,11 +60,12 @@ public ValidatingMongoEventListener(Validator validator) {
 	public void onBeforeSave(Object source, DBObject dbo) {
 
 		LOG.debug("Validating object: {}", source);
-		Set violations = validator.validate(source);
+		final Object target = source instanceof LazyLoadingProxy ? ((LazyLoadingProxy) source).getTarget() : source;
+		final Set violations = validator.validate(target);
 
 		if (!violations.isEmpty()) {
 
-			LOG.info("During object: {} validation violations found: {}", source, violations);
+			LOG.info("During object: {} validation violations found: {}", target, violations);
 			throw new ConstraintViolationException(violations);
 		}
 	}

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/mapping/event/Address.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2016 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.core.mapping.event;
+
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Size;
+
+import org.bson.types.ObjectId;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.mongodb.core.mapping.Document;
+
+/**
+ * @see DATAMONGO-1393
+ * @author Paul Sterl
+ */
+@Document(collection = "ADDRESS")
+public class Address {
+
+	@Id
+	private ObjectId id;
+	
+	@NotNull @Size(min = 2)
+	private String name;
+
+	public Address() {
+		super();
+	}
+	public Address(String name) {
+		this();
+		this.name = name;
+	}
+	public ObjectId getId() {
+		return id;
+	}
+	public void setId(ObjectId id) {
+		this.id = id;
+	}
+	public String getName() {
+		return name;
+	}
+	public void setName(String name) {
+		this.name = name;
+	}
+}

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/mapping/event/User.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -15,28 +15,93 @@
  */
 package org.springframework.data.mongodb.core.mapping.event;
 
+import java.util.ArrayList;
+import java.util.List;
+
 import javax.validation.constraints.Min;
 import javax.validation.constraints.Size;
 
+import org.bson.types.ObjectId;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.mongodb.core.mapping.DBRef;
+import org.springframework.data.mongodb.core.mapping.Document;
+import org.springframework.data.mongodb.core.mapping.event.User.AddressRelation.Type;
+
 /**
  * Class used to test JSR-303 validation
  * {@link org.springframework.data.mongodb.core.mapping.event.ValidatingMongoEventListener}
  * 
  * @see DATAMONGO-36
  * @author Maciej Walkowiak
+ * @author Paul Sterl
  */
+@Document(collection = "USER")
 public class User {
+	
+	public static class AddressRelation {
+		public enum Type {
+			PRIVATE,
+			WORK
+		}
+		private Type type = Type.PRIVATE;
+		@DBRef(lazy = true)
+		private Address address;
+		// needed otherwise spring doesn't create the proxy for some reason ...
+		public AddressRelation() {
+			super();
+		}
+		public AddressRelation(Type type, Address address) {
+			this();
+			this.type = type;
+			this.address = address;
+		}
+		public Type getType() {
+			return type;
+		}
+		public void setType(Type type) {
+			this.type = type;
+		}
+		public Address getAddress() {
+			return address;
+		}
+		public void setAddress(Address address) {
+			this.address = address;
+		}
+	}
+
+	@Id
+	private ObjectId id;
 
 	@Size(min = 10)
 	private String name;
 
 	@Min(18)
 	private Integer age;
+	
+	private List<AddressRelation> addresses = new ArrayList<AddressRelation>();
 
+	public User() {
+		super();
+	}
 	public User(String name, Integer age) {
+		this();
 		this.name = name;
 		this.age = age;
 	}
+	public User(String name, Integer age, Address...addresses) {
+		this(name, age);
+		for (Address address : addresses) {
+			this.addresses.add(new AddressRelation(Type.WORK, address));
+		}
+	}
+
+	public ObjectId getId() {
+		return id;
+	}
+
+	public void setId(ObjectId id) {
+		this.id = id;
+	}
 
 	public String getName() {
 		return name;
@@ -45,4 +110,10 @@ public String getName() {
 	public Integer getAge() {
 		return age;
 	}
+	public List<AddressRelation> getAddresses() {
+		return addresses;
+	}
+	public void setAddresses(List<AddressRelation> addresses) {
+		this.addresses = addresses;
+	}
 }

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/mapping/event/ValidatingMongoEventListenerTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2012-2014 the original author or authors.
+ * Copyright 2012-2016 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.
@@ -18,13 +18,17 @@
 import static org.hamcrest.core.IsEqual.*;
 import static org.junit.Assert.*;
 
+import java.util.UUID;
+
 import javax.validation.ConstraintViolationException;
 
 import org.junit.ClassRule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.data.mongodb.core.MongoTemplate;
+import org.springframework.data.mongodb.core.convert.LazyLoadingProxy;
+import org.springframework.data.mongodb.core.mapping.event.repo.AddressRepository;
+import org.springframework.data.mongodb.core.mapping.event.repo.UserRepository;
 import org.springframework.data.mongodb.test.util.MongoVersionRule;
 import org.springframework.data.util.Version;
 import org.springframework.test.context.ContextConfiguration;
@@ -37,22 +41,24 @@
  * @author Maciej Walkowiak
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Paul Sterl
  */
 @RunWith(SpringJUnit4ClassRunner.class)
 @ContextConfiguration
 public class ValidatingMongoEventListenerTests {
 
 	public static @ClassRule MongoVersionRule version = MongoVersionRule.atLeast(new Version(2, 6));
 
-	@Autowired MongoTemplate mongoTemplate;
+	@Autowired AddressRepository addressRepo;
+	@Autowired UserRepository userRepo;
 
 	@Test
 	public void shouldThrowConstraintViolationException() {
 
 		User user = new User("john", 17);
 
 		try {
-			mongoTemplate.save(user);
+			userRepo.save(user);
 			fail();
 		} catch (ConstraintViolationException e) {
 			assertThat(e.getConstraintViolations().size(), equalTo(2));
@@ -61,6 +67,34 @@ public void shouldThrowConstraintViolationException() {
 
 	@Test
 	public void shouldNotThrowAnyExceptions() {
-		mongoTemplate.save(new User("john smith", 18));
+		userRepo.save(new User("john smith", 18));
+	}
+	
+	/**
+	 * @see DATAMONGO-1393
+	 */
+	@Test
+	public void validationOfLazyProxy() {
+		Address address = addressRepo.insert(new Address(UUID.randomUUID().toString()));
+		User user = userRepo.insert(new User("Foo Bar Name 123456", 18, address));
+		
+		user = userRepo.findOne(user.getId());
+		assertTrue("Spring should use now a LazyLoadingProxy.", user.getAddresses().get(0).getAddress() instanceof LazyLoadingProxy);
+		address = user.getAddresses().get(0).getAddress();
+		address.setName("New Fancy Address Name");
+		addressRepo.save(address);
+	}
+	/**
+	 * @see DATAMONGO-1393
+	 */
+	@Test(expected = ConstraintViolationException.class)
+	public void validationErrorTest() {
+		Address address = addressRepo.insert(new Address(UUID.randomUUID().toString()));
+		User user = userRepo.insert(new User("Foo Bar Name 123456", 18, address));
+		
+		user = userRepo.findOne(user.getId());
+		address = user.getAddresses().get(0).getAddress();
+		address.setName(null);
+		addressRepo.save(address);
 	}
 }

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/mapping/event/repo/AddressRepository.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2016 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.
+ * 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.core.mapping.event.repo;
+
+import org.bson.types.ObjectId;
+import org.springframework.data.mongodb.core.mapping.event.Address;
+import org.springframework.data.mongodb.repository.MongoRepository;
+
+/**
+ * @author Paul Sterl
+ */
+public interface AddressRepository extends MongoRepository<Address, ObjectId> {
+}

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/mapping/event/repo/UserRepository.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2016 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.
+ * 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.core.mapping.event.repo;
+
+import org.bson.types.ObjectId;
+import org.springframework.data.mongodb.core.mapping.event.User;
+import org.springframework.data.mongodb.repository.MongoRepository;
+
+/**
+ * @author Paul Sterl
+ */
+public interface UserRepository extends MongoRepository<User, ObjectId> {
+}

spring-data-mongodb/src/test/resources/org/springframework/data/mongodb/core/mapping/event/ValidatingMongoEventListenerTests-context.xml

@@ -10,6 +10,7 @@
 	<mongo:db-factory dbname="validation" />
 
 	<mongo:mapping-converter base-package="org.springframework.data.mongodb.core" />
+    <mongo:repositories base-package="org.springframework.data.mongodb.core.mapping.event.repo" />
 
 	<bean id="mongoTemplate" class="org.springframework.data.mongodb.core.MongoTemplate">
 		<constructor-arg name="mongoDbFactory" ref="mongoDbFactory" />