DATAMONGO-2073 - Evaluate exception label when translating MongoExceptions.

We now distinguish between Transient and NonTransient failures by checking the Error labels of an Error and create the according DataAccessException based on that information.

These URLs were switched to an https URL with a 2xx status. While the status was successful, your review is still recommended.

* [ ] http://www.apache.org/licenses/ with 1 occurrences migrated to:
  https://www.apache.org/licenses/ ([https](https://www.apache.org/licenses/) result 200).
* [ ] http://www.apache.org/licenses/LICENSE-2.0 with 852 occurrences migrated to:
  https://www.apache.org/licenses/LICENSE-2.0 ([https](https://www.apache.org/licenses/LICENSE-2.0) result 200).

Original Pull Request: #721

Author: christophstrobl

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/TransientClientSessionException.java

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2018 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
+ *
+ *      https://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;
+
+import org.springframework.dao.TransientDataAccessException;
+import org.springframework.lang.Nullable;
+
+/**
+ * {@link TransientDataAccessException} specific to MongoDB {@link com.mongodb.session.ClientSession} related data
+ * access failures such as reading data using an already closed session.
+ *
+ * @author Christoph Strobl
+ * @since 2.1
+ */
+public class TransientClientSessionException extends TransientMongoDbException {
+
+	/**
+	 * Constructor for {@link TransientClientSessionException}.
+	 *
+	 * @param msg the detail message. Must not be {@literal null}.
+	 */
+	public TransientClientSessionException(String msg) {
+		super(msg);
+	}
+
+	/**
+	 * Constructor for {@link TransientClientSessionException}.
+	 *
+	 * @param msg the detail message. Can be {@literal null}.
+	 * @param cause the root cause. Can be {@literal null}.
+	 */
+	public TransientClientSessionException(@Nullable String msg, @Nullable Throwable cause) {
+		super(msg, cause);
+	}
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/TransientMongoDbException.java

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2018 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
+ *
+ *      https://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;
+
+import org.springframework.dao.TransientDataAccessException;
+import org.springframework.lang.Nullable;
+
+/**
+ * Root of the hierarchy of MongoDB specific data access exceptions that are considered transient such as
+ * {@link com.mongodb.MongoException MongoExceptions} carrying {@link com.mongodb.MongoException#hasErrorLabel(String)
+ * specific labels}.
+ *
+ * @author Christoph Strobl
+ * @since 2.1
+ */
+public class TransientMongoDbException extends TransientDataAccessException {
+
+	/**
+	 * Constructor for {@link TransientMongoDbException}.
+	 *
+	 * @param msg the detail message. Must not be {@literal null}.
+	 */
+	public TransientMongoDbException(String msg) {
+		super(msg);
+	}
+
+	/**
+	 * Constructor for {@link TransientMongoDbException}.
+	 *
+	 * @param msg the detail message. Can be {@literal null}.
+	 * @param cause the root cause. Can be {@literal null}.
+	 */
+	public TransientMongoDbException(String msg, @Nullable Throwable cause) {
+		super(msg, cause);
+	}
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/TransientMongoDbTransactionException.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2018 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
+ *
+ *      https://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;
+
+import org.springframework.lang.Nullable;
+
+/**
+ * A specific {@link TransientClientSessionException} related to issues with a transaction such as fails on commit.
+ *
+ * @author Christoph Strobl
+ * @since 2.1
+ */
+public class TransientMongoDbTransactionException extends TransientClientSessionException {
+
+	/**
+	 * Constructor for {@link TransientMongoDbTransactionException}.
+	 *
+	 * @param msg the detail message. Must not be {@literal null}.
+	 */
+	public TransientMongoDbTransactionException(String msg) {
+		super(msg);
+	}
+
+	/**
+	 * Constructor for {@link ClientSessionException}.
+	 *
+	 * @param msg the detail message. Can be {@literal null}.
+	 * @param cause the root cause. Can be {@literal null}.
+	 */
+	public TransientMongoDbTransactionException(@Nullable String msg, @Nullable Throwable cause) {
+		super(msg, cause);
+	}
+}

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

@@ -29,9 +29,13 @@
 import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.dao.InvalidDataAccessResourceUsageException;
 import org.springframework.dao.PermissionDeniedDataAccessException;
+import org.springframework.dao.TransientDataAccessException;
 import org.springframework.dao.support.PersistenceExceptionTranslator;
 import org.springframework.data.mongodb.ClientSessionException;
 import org.springframework.data.mongodb.MongoTransactionException;
+import org.springframework.data.mongodb.TransientClientSessionException;
+import org.springframework.data.mongodb.TransientMongoDbException;
+import org.springframework.data.mongodb.TransientMongoDbTransactionException;
 import org.springframework.data.mongodb.UncategorizedMongoDbException;
 import org.springframework.data.mongodb.util.MongoDbErrorCodes;
 import org.springframework.lang.Nullable;
@@ -75,6 +79,21 @@ public class MongoExceptionTranslator implements PersistenceExceptionTranslator
 	@Nullable
 	public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
 
+		DataAccessException translatedException = doTranslateException(ex);
+		if (translatedException == null) {
+			return null;
+		}
+
+		// Translated exceptions that per se are not be recoverable (eg. WriteConflicts), might still be transient inside a
+		// transaction. Let's wrap those.
+		return (isTransientFailure(ex) && !(translatedException instanceof TransientDataAccessException))
+				? new TransientMongoDbException(ex.getMessage(), translatedException) : translatedException;
+
+	}
+
+	@Nullable
+	DataAccessException doTranslateException(RuntimeException ex) {
+
 		// Check for well-known MongoException subclasses.
 
 		if (ex instanceof BsonInvalidOperationException) {
@@ -120,7 +139,9 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
 		// All other MongoExceptions
 		if (ex instanceof MongoException) {
 
-			int code = ((MongoException) ex).getCode();
+			MongoException mongoException = (MongoException) ex;
+			int code = mongoException.getCode();
+			boolean isTransient = isTransientFailure(mongoException);
 
 			if (MongoDbErrorCodes.isDuplicateKeyCode(code)) {
 				return new DuplicateKeyException(ex.getMessage(), ex);
@@ -132,9 +153,11 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
 			} else if (MongoDbErrorCodes.isPermissionDeniedCode(code)) {
 				return new PermissionDeniedDataAccessException(ex.getMessage(), ex);
 			} else if (MongoDbErrorCodes.isClientSessionFailureCode(code)) {
-				return new ClientSessionException(ex.getMessage(), ex);
+				return isTransient ? new TransientClientSessionException(ex.getMessage(), ex)
+						: new ClientSessionException(ex.getMessage(), ex);
 			} else if (MongoDbErrorCodes.isTransactionFailureCode(code)) {
-				return new MongoTransactionException(ex.getMessage(), ex);
+				return isTransient ? new TransientMongoDbTransactionException(ex.getMessage(), ex)
+						: new MongoTransactionException(ex.getMessage(), ex);
 			}
 
 			return new UncategorizedMongoDbException(ex.getMessage(), ex);
@@ -155,4 +178,25 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
 		// that translation should not occur.
 		return null;
 	}
+
+	/**
+	 * Check if a given exception holds an error label indicating a transient failure.
+	 *
+	 * @param e
+	 * @return {@literal true} if the given {@link Exception} is a {@link MongoException} holding one of the transient
+	 *         exception error labels.
+	 * @see MongoException#hasErrorLabel(String)
+	 * @since 2.1
+	 */
+	public static boolean isTransientFailure(Exception e) {
+
+		if (!(e instanceof MongoException)) {
+			return false;
+		}
+
+		MongoException mongoException = (MongoException) e;
+
+		return mongoException.hasErrorLabel(MongoException.TRANSIENT_TRANSACTION_ERROR_LABEL)
+				|| mongoException.hasErrorLabel(MongoException.UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL);
+	}
 }

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

@@ -17,18 +17,25 @@
 
 import static org.assertj.core.api.Assertions.*;
 
+import com.mongodb.MongoCommandException;
+import com.mongodb.MongoWriteException;
+import com.mongodb.WriteError;
 import org.bson.BsonDocument;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
 import org.springframework.core.NestedRuntimeException;
 import org.springframework.dao.DataAccessException;
 import org.springframework.dao.DataAccessResourceFailureException;
+import org.springframework.dao.DataIntegrityViolationException;
 import org.springframework.dao.DuplicateKeyException;
 import org.springframework.dao.InvalidDataAccessApiUsageException;
 import org.springframework.dao.InvalidDataAccessResourceUsageException;
+import org.springframework.dao.TransientDataAccessException;
 import org.springframework.data.mongodb.ClientSessionException;
 import org.springframework.data.mongodb.MongoTransactionException;
+import org.springframework.data.mongodb.TransientMongoDbException;
+import org.springframework.data.mongodb.TransientMongoDbTransactionException;
 import org.springframework.data.mongodb.UncategorizedMongoDbException;
 import org.springframework.lang.Nullable;
 
@@ -171,6 +178,38 @@ void translateTransactionExceptions() {
 		checkTranslatedMongoException(MongoTransactionException.class, 267);
 	}
 
+	@Test // DATAMONGO-2073
+	public void translateTransientTransactionExceptions() {
+
+		MongoException source = new MongoException(267, "PreparedTransactionInProgress");
+		source.addLabel(MongoException.TRANSIENT_TRANSACTION_ERROR_LABEL);
+
+		expectExceptionWithCauseMessage(translator.translateExceptionIfPossible(source),
+				TransientMongoDbTransactionException.class, "PreparedTransactionInProgress");
+	}
+
+	@Test  // DATAMONGO-2073
+	public void translateMongoExceptionWithTransientLabelToTransientMongoDbException() {
+
+		MongoException exception = new MongoException(0, "");
+		exception.addLabel(MongoException.UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL);
+		DataAccessException translatedException = translator.translateExceptionIfPossible(exception);
+
+		expectExceptionWithCauseMessage(translatedException, TransientMongoDbException.class);
+	}
+
+	@Test  // DATAMONGO-2073
+	public void wrapsTranslatedExceptionsWhenTransientLabelPresent() {
+
+		MongoException exception = new MongoWriteException(new WriteError(112, "WriteConflict", new BsonDocument()), null);
+		exception.addLabel(MongoException.UNKNOWN_TRANSACTION_COMMIT_RESULT_LABEL);
+
+		DataAccessException translatedException = translator.translateExceptionIfPossible(exception);
+
+		assertThat(translatedException).isInstanceOf(TransientMongoDbException.class);
+		assertThat(translatedException.getCause()).isInstanceOf(DataIntegrityViolationException.class);
+	}
+
 	private void checkTranslatedMongoException(Class<? extends Exception> clazz, int code) {
 
 		DataAccessException translated = translator.translateExceptionIfPossible(new MongoException(code, ""));