DATAMONGO-2195 - Throw OptimisticLockingFailureException on delete only in repositories.

OptimisticLockingFailureException is now thrown only when deleting an entity through a repository and no longer when using the Template API.

Original pull request: #641.

Author: mp911de

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

@@ -1730,36 +1730,10 @@ public DeleteResult doInCollection(MongoCollection<Document> collection)
 				DeleteResult result = multi ? collectionToUse.deleteMany(removeQuery, options)
 						: collectionToUse.deleteOne(removeQuery, options);
 
-				checkForOptimisticLockingFailures(result, removeQuery, collectionToUse);
-
 				maybeEmitEvent(new AfterDeleteEvent<>(queryObject, entityClass, collectionName));
 
 				return result;
 			}
-
-			private void checkForOptimisticLockingFailures(DeleteResult result, Document removeQuery,
-					MongoCollection<Document> collectionToUse) {
-
-				if (multi || !ResultOperations.isUndecidedDeleteResult(result, removeQuery, entity)) {
-					return;
-				}
-
-				String versionFieldName = entity.getVersionProperty().getFieldName();
-				Document idQuery = new Document(removeQuery);
-				idQuery.remove(versionFieldName);
-
-				Iterator<Document> it = collectionToUse.find(idQuery).projection(Projections.include("_id", versionFieldName))
-						.limit(1).iterator();
-
-				if (it.hasNext()) {
-
-					Document source = it.next();
-					throw ResultOperations.newDeleteVersionedOptimisticLockingException(source.get("_id"), collectionName,
-							removeQuery.get(versionFieldName), source.get(versionFieldName));
-
-				}
-
-			}
 		});
 	}
 

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

@@ -1824,35 +1824,6 @@ protected <T> Mono<DeleteResult> doRemove(String collectionName, Query query, @N
 				return collectionToUse.deleteMany(removeQuery, deleteOptions);
 			}
 
-		}).flatMap(deleteResult -> {
-
-			if (!ResultOperations.isUndecidedDeleteResult(deleteResult, removeQuery, entity)) {
-				return Mono.just(deleteResult);
-			}
-
-			return execute(collectionName, (coll -> {
-
-				String versionFieldName = entity.getVersionProperty().getFieldName();
-
-				Document queryWithoutVersion = new Document(removeQuery);
-				queryWithoutVersion.remove(versionFieldName);
-
-				Publisher<Document> publisher = coll.find(queryWithoutVersion)
-						.projection(Projections.include("_id", entity.getVersionProperty().getFieldName())).limit(1).first();
-
-				return Mono.from(publisher) //
-						.defaultIfEmpty(new Document()) //
-						.flatMap(it -> {
-
-							if (it.isEmpty()) {
-								return Mono.just(deleteResult);
-							}
-
-							return Mono.error(ResultOperations.newDeleteVersionedOptimisticLockingException(it.get("_id"),
-									collectionName, removeQuery.get(versionFieldName), it.get(versionFieldName)));
-						});
-			})).next();
-
 		}).doOnNext(it -> maybeEmitEvent(new AfterDeleteEvent<>(queryObject, entityClass, collectionName))) //
 				.next();
 	}

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

@@ -16,11 +16,13 @@
 package org.springframework.data.mongodb.repository.query;
 
 import org.springframework.data.repository.core.EntityInformation;
+import org.springframework.lang.Nullable;
 
 /**
  * Mongo specific {@link EntityInformation}.
  *
  * @author Oliver Gierke
+ * @author Mark Paluch
  */
 public interface MongoEntityInformation<T, ID> extends EntityInformation<T, ID> {
 
@@ -37,4 +39,25 @@ public interface MongoEntityInformation<T, ID> extends EntityInformation<T, ID>
 	 * @return
 	 */
 	String getIdAttribute();
+
+	/**
+	 * Returns whether the entity uses optimistic locking.
+	 *
+	 * @return
+	 * @since 2.2
+	 */
+	default boolean isVersioned() {
+		return false;
+	}
+
+	/**
+	 * Returns the version value for the entity or {@literal null} if the entity is not {@link #isVersioned() versioned}.
+	 *
+	 * @param entity must not be {@literal null}
+	 * @return
+	 */
+	@Nullable
+	default Object getVersion(T entity) {
+		return null;
+	}
 }

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

@@ -16,6 +16,7 @@
 package org.springframework.data.mongodb.repository.support;
 
 import org.bson.types.ObjectId;
+import org.springframework.data.mapping.PersistentPropertyAccessor;
 import org.springframework.data.mongodb.core.mapping.MongoPersistentEntity;
 import org.springframework.data.mongodb.repository.query.MongoEntityInformation;
 import org.springframework.data.repository.core.support.PersistentEntityInformation;
@@ -87,14 +88,16 @@ private MappingMongoEntityInformation(MongoPersistentEntity<T> entity, @Nullable
 		this.fallbackIdType = idType != null ? idType : (Class<ID>) ObjectId.class;
 	}
 
-	/* (non-Javadoc)
+	/*
+	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.repository.MongoEntityInformation#getCollectionName()
 	 */
 	public String getCollectionName() {
 		return customCollectionName == null ? entityMetadata.getCollection() : customCollectionName;
 	}
 
-	/* (non-Javadoc)
+	/*
+	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.repository.MongoEntityInformation#getIdAttribute()
 	 */
 	public String getIdAttribute() {
@@ -106,7 +109,6 @@ public String getIdAttribute() {
 	 * @see org.springframework.data.repository.core.support.PersistentEntityInformation#getIdType()
 	 */
 	@Override
-	@SuppressWarnings("unchecked")
 	public Class<ID> getIdType() {
 
 		if (this.entityMetadata.hasIdProperty()) {
@@ -115,4 +117,30 @@ public Class<ID> getIdType() {
 
 		return fallbackIdType;
 	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.repository.MongoEntityInformation#isVersioned()
+	 */
+	@Override
+	public boolean isVersioned() {
+		return this.entityMetadata.hasVersionProperty();
+	}
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.repository.MongoEntityInformation#getVersion(Object)
+	 */
+	@Override
+	public Object getVersion(T entity) {
+
+		if (!isVersioned()) {
+			return null;
+		}
+
+		PersistentPropertyAccessor<T> accessor = this.entityMetadata.getPropertyAccessor(entity);
+
+		return accessor.getProperty(this.entityMetadata.getRequiredVersionProperty());
+	}
+
 }

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/support/MappingMongoEntityInformation.java

@@ -23,6 +23,7 @@
 import java.util.Optional;
 import java.util.stream.Collectors;
 
+import org.springframework.dao.OptimisticLockingFailureException;
 import org.springframework.data.domain.Example;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.PageImpl;
@@ -40,6 +41,8 @@
 import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
+import com.mongodb.client.result.DeleteResult;
+
 /**
  * Repository base implementation for Mongo.
  *
@@ -161,7 +164,14 @@ public void delete(T entity) {
 
 		Assert.notNull(entity, "The given entity must not be null!");
 
-		mongoOperations.remove(entity, entityInformation.getCollectionName());
+		DeleteResult deleteResult = mongoOperations.remove(entity, entityInformation.getCollectionName());
+
+		if (entityInformation.isVersioned() && deleteResult.wasAcknowledged() && deleteResult.getDeletedCount() == 0) {
+			throw new OptimisticLockingFailureException(String.format(
+					"The entity with id %s with version %s in %s cannot be deleted! Was it modified or deleted in the meantime?",
+					entityInformation.getId(entity), entityInformation.getVersion(entity),
+					entityInformation.getCollectionName()));
+		}
 	}
 
 	/*

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/repository/support/SimpleMongoRepository.java

@@ -28,6 +28,7 @@
 
 import org.reactivestreams.Publisher;
 import org.springframework.dao.IncorrectResultSizeDataAccessException;
+import org.springframework.dao.OptimisticLockingFailureException;
 import org.springframework.data.domain.Example;
 import org.springframework.data.domain.Sort;
 import org.springframework.data.mongodb.core.ReactiveMongoOperations;
@@ -39,6 +40,8 @@
 import org.springframework.data.util.Streamable;
 import org.springframework.util.Assert;
 
+import com.mongodb.client.result.DeleteResult;
+
 /**
  * Reactive repository base implementation for Mongo.
  *
@@ -355,7 +358,24 @@ public Mono<Void> delete(T entity) {
 
 		Assert.notNull(entity, "The given entity must not be null!");
 
-		return mongoOperations.remove(entity, entityInformation.getCollectionName()).then();
+		Mono<DeleteResult> remove = mongoOperations.remove(entity, entityInformation.getCollectionName());
+
+		if (entityInformation.isVersioned()) {
+
+			remove = remove.handle((deleteResult, sink) -> {
+
+				if (deleteResult.wasAcknowledged() && deleteResult.getDeletedCount() == 0) {
+					sink.error(new OptimisticLockingFailureException(String.format(
+							"The entity with id %s with version %s in %s cannot be deleted! Was it modified or deleted in the meantime?",
+							entityInformation.getId(entity), entityInformation.getVersion(entity),
+							entityInformation.getCollectionName())));
+				} else {
+					sink.next(deleteResult);
+				}
+			});
+		}
+
+		return remove.then();
 	}
 
 	/*
@@ -367,7 +387,7 @@ public Mono<Void> deleteAll(Iterable<? extends T> entities) {
 
 		Assert.notNull(entities, "The given Iterable of entities must not be null!");
 
-		return Flux.fromIterable(entities).flatMap(entity -> deleteById(entityInformation.getRequiredId(entity))).then();
+		return Flux.fromIterable(entities).flatMap(this::delete).then();
 	}
 
 	/*