Improve MongoExceptionTranslator to accept MongoSocketException children.

Closes spring-projects#3568

Author: boly38

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

@@ -15,6 +15,9 @@
  */
 package org.springframework.data.mongodb.core;
 
+import static java.lang.String.format;
+import static java.util.Arrays.asList;
+
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
@@ -49,21 +52,28 @@
  * @author Oliver Gierke
  * @author Michal Vich
  * @author Christoph Strobl
+ * @author Brice Vandeputte
  */
 public class MongoExceptionTranslator implements PersistenceExceptionTranslator {
+	/**
+	 * translation matrix definitions:
+	 * - adding {@code ClassShortName} will associate a given exception class to a translated group
+	 * - adding {@code ClassShortName$children} will associate a given exception direct children to a translated group
+	 */
 
 	private static final Set<String> DUPLICATE_KEY_EXCEPTIONS = new HashSet<>(
-			Arrays.asList("MongoException.DuplicateKey", "DuplicateKeyException"));
+			asList("MongoException.DuplicateKey", "DuplicateKeyException"));
 
 	private static final Set<String> RESOURCE_FAILURE_EXCEPTIONS = new HashSet<>(
-			Arrays.asList("MongoException.Network", "MongoSocketException", "MongoException.CursorNotFound",
-					"MongoCursorNotFoundException", "MongoServerSelectionException", "MongoTimeoutException"));
+			asList("MongoException.Network", "MongoSocketException", "MongoSocketException$children",
+					"MongoException.CursorNotFound", "MongoCursorNotFoundException", "MongoServerSelectionException",
+					"MongoTimeoutException"));
 
 	private static final Set<String> RESOURCE_USAGE_EXCEPTIONS = new HashSet<>(
 			Collections.singletonList("MongoInternalException"));
 
 	private static final Set<String> DATA_INTEGRITY_EXCEPTIONS = new HashSet<>(
-			Arrays.asList("WriteConcernException", "MongoWriteException", "MongoBulkWriteException"));
+			asList("WriteConcernException", "MongoWriteException", "MongoBulkWriteException"));
 
 	/*
 	 * (non-Javadoc)
@@ -78,21 +88,25 @@ public DataAccessException translateExceptionIfPossible(RuntimeException ex) {
 			throw new InvalidDataAccessApiUsageException(ex.getMessage(), ex);
 		}
 
-		String exception = ClassUtils.getShortName(ClassUtils.getUserClass(ex.getClass()));
+		Class<? extends RuntimeException> exceptionClass = ex.getClass();
+		String exception = ClassUtils.getShortName(ClassUtils.getUserClass(exceptionClass));
+		String exceptionParentMatcher = format("%s$children",
+				ClassUtils.getShortName(ClassUtils.getUserClass(exceptionClass.getSuperclass()))
+		);
 
-		if (DUPLICATE_KEY_EXCEPTIONS.contains(exception)) {
+		if (!Collections.disjoint(DUPLICATE_KEY_EXCEPTIONS, asList(exception, exceptionParentMatcher))) {
 			return new DuplicateKeyException(ex.getMessage(), ex);
 		}
 
-		if (RESOURCE_FAILURE_EXCEPTIONS.contains(exception)) {
+		if (!Collections.disjoint(RESOURCE_FAILURE_EXCEPTIONS, asList(exception, exceptionParentMatcher))) {
 			return new DataAccessResourceFailureException(ex.getMessage(), ex);
 		}
 
-		if (RESOURCE_USAGE_EXCEPTIONS.contains(exception)) {
+		if (!Collections.disjoint(RESOURCE_USAGE_EXCEPTIONS, asList(exception, exceptionParentMatcher))) {
 			return new InvalidDataAccessResourceUsageException(ex.getMessage(), ex);
 		}
 
-		if (DATA_INTEGRITY_EXCEPTIONS.contains(exception)) {
+		if (!Collections.disjoint(DATA_INTEGRITY_EXCEPTIONS, asList(exception, exceptionParentMatcher))) {
 
 			if (ex instanceof MongoServerException) {
 				if (((MongoServerException) ex).getCode() == 11000) {

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

@@ -17,6 +17,9 @@
 
 import static org.assertj.core.api.Assertions.*;
 
+import com.mongodb.MongoSocketReadTimeoutException;
+import com.mongodb.MongoSocketWriteException;
+import java.io.IOException;
 import java.net.UnknownHostException;
 
 import org.bson.BsonDocument;
@@ -45,9 +48,11 @@
  * @author Michal Vich
  * @author Oliver Gierke
  * @author Christoph Strobl
+ * @author Brice Vandeputte
  */
 public class MongoExceptionTranslatorUnitTests {
 
+	public static final String EXCEPTION_MESSAGE = "IOException";
 	MongoExceptionTranslator translator;
 
 	@BeforeEach
@@ -68,13 +73,30 @@ public void translateDuplicateKey() {
 	public void translateSocketException() {
 
 		expectExceptionWithCauseMessage(
-				translator.translateExceptionIfPossible(new MongoSocketException("IOException", new ServerAddress())),
-				DataAccessResourceFailureException.class, "IOException");
+				translator.translateExceptionIfPossible(new MongoSocketException(EXCEPTION_MESSAGE, new ServerAddress())),
+				DataAccessResourceFailureException.class, EXCEPTION_MESSAGE);
+
+	}
+
+	@Test // GH-3568
+	public void translateSocketChildrenExceptions() {
+
+		expectExceptionWithCauseMessage(
+				translator.translateExceptionIfPossible(
+						new MongoSocketWriteException("intermediate message", new ServerAddress(), new Exception(EXCEPTION_MESSAGE))
+				),
+				DataAccessResourceFailureException.class, EXCEPTION_MESSAGE);
+
+		expectExceptionWithCauseMessage(
+				translator.translateExceptionIfPossible(
+						new MongoSocketReadTimeoutException("intermediate message", new ServerAddress(), new Exception(EXCEPTION_MESSAGE))
+				),
+				DataAccessResourceFailureException.class, EXCEPTION_MESSAGE);
 
 	}
 
 	@Test
-	public void translateCursorNotFound() throws UnknownHostException {
+	public void translateCursorNotFound() {
 
 		expectExceptionWithCauseMessage(
 				translator.translateExceptionIfPossible(new MongoCursorNotFoundException(1L, new ServerAddress())),