Require explicit UUID representation configuration

Signed-off-by: Hyunsang Han <[email protected]>

Author: HyunSangHan

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/config/MongoConfigurationSupport.java

@@ -46,6 +46,7 @@
  * Base class for Spring Data MongoDB to be extended for JavaConfiguration usage.
  *
  * @author Mark Paluch
+ * @author Hyunsang Han
  * @since 2.0
  */
 public abstract class MongoConfigurationSupport {
@@ -226,9 +227,15 @@ protected boolean autoIndexCreation() {
 	protected MongoClientSettings mongoClientSettings() {
 
 		MongoClientSettings.Builder builder = MongoClientSettings.builder();
-		builder.uuidRepresentation(UuidRepresentation.STANDARD);
 		configureClientSettings(builder);
-		return builder.build();
+		
+		MongoClientSettings settings = builder.build();
+		
+		if (settings.getUuidRepresentation() == null) {
+			throw new IllegalStateException("UUID representation must be explicitly configured.");
+		}
+		
+		return settings;
 	}
 
 	/**

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

@@ -23,7 +23,6 @@
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
-import org.bson.UuidRepresentation;
 import org.jspecify.annotations.Nullable;
 import org.springframework.beans.factory.config.AbstractFactoryBean;
 import org.springframework.dao.DataAccessException;
@@ -52,6 +51,7 @@
  *
  * @author Christoph Strobl
  * @author Mark Paluch
+ * @author Hyunsang Han
  */
 public class MongoClientFactoryBean extends AbstractFactoryBean<MongoClient> implements PersistenceExceptionTranslator {
 
@@ -162,7 +162,6 @@ protected MongoClientSettings computeClientSetting() {
 						getOrDefault(port, "" + ServerAddress.defaultPort())));
 
 		Builder builder = MongoClientSettings.builder().applyConnectionString(connectionString);
-		builder.uuidRepresentation(UuidRepresentation.STANDARD);
 
 		if (mongoClientSettings != null) {
 
@@ -305,7 +304,13 @@ protected MongoClientSettings computeClientSetting() {
 			});
 		}
 
-		return builder.build();
+		MongoClientSettings settings = builder.build();
+		
+		if (settings.getUuidRepresentation() == null) {
+			throw new IllegalStateException("UUID representation must be explicitly configured.");
+		}
+		
+		return settings;
 	}
 
 	private <T> void applySettings(Consumer<T> settingsBuilder, @Nullable T value) {

spring-data-mongodb/src/test/java/org/springframework/data/mongodb/config/AbstractMongoConfigurationUnitTests.java

@@ -45,6 +45,9 @@
 import org.springframework.data.spel.ExtensionAwareEvaluationContextProvider;
 import org.springframework.test.util.ReflectionTestUtils;
 
+import org.bson.UuidRepresentation;
+
+import com.mongodb.MongoClientSettings;
 import com.mongodb.client.MongoClient;
 
 /**
@@ -53,6 +56,7 @@
  * @author Oliver Gierke
  * @author Thomas Darimont
  * @author Mark Paluch
+ * @author Hyunsang Han
  */
 public class AbstractMongoConfigurationUnitTests {
 
@@ -114,6 +118,40 @@ public void lifecycleCallbacksAreInvokedInAppropriateOrder() {
 		context.close();
 	}
 
+	@Test // GH-5037
+	public void requiresExplicitUuidRepresentationConfiguration() {
+
+		assertThatThrownBy(() -> {
+			AbstractMongoClientConfiguration config = new AbstractMongoClientConfiguration() {
+				@Override
+				protected String getDatabaseName() {
+					return "test";
+				}
+			};
+			config.mongoClientSettings();
+		}).isInstanceOf(IllegalStateException.class)
+		  .hasMessageContaining("UUID representation must be explicitly configured");
+	}
+
+	@Test // GH-5037
+	public void worksWithExplicitUuidRepresentationConfiguration() {
+
+		AbstractMongoClientConfiguration config = new AbstractMongoClientConfiguration() {
+			@Override
+			protected String getDatabaseName() {
+				return "test";
+			}
+
+			@Override
+			protected void configureClientSettings(MongoClientSettings.Builder builder) {
+				builder.uuidRepresentation(UuidRepresentation.STANDARD);
+			}
+		};
+
+		MongoClientSettings settings = config.mongoClientSettings();
+		assertThat(settings.getUuidRepresentation()).isEqualTo(UuidRepresentation.STANDARD);
+	}
+
 	@Test // DATAMONGO-725
 	public void shouldBeAbleToConfigureCustomTypeMapperViaJavaConfig() {
 
@@ -158,6 +196,11 @@ protected String getDatabaseName() {
 			return "database";
 		}
 
+		@Override
+		protected void configureClientSettings(MongoClientSettings.Builder builder) {
+			builder.uuidRepresentation(UuidRepresentation.STANDARD);
+		}
+
 		@Override
 		public MongoClient mongoClient() {
 			return Mockito.mock(MongoClient.class);

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

@@ -21,6 +21,8 @@
 
 import org.junit.jupiter.api.Test;
 
+import org.bson.UuidRepresentation;
+
 import com.mongodb.ConnectionString;
 import com.mongodb.MongoClientSettings;
 import com.mongodb.ServerAddress;
@@ -29,6 +31,7 @@
  * Unit tests for {@link MongoClientFactoryBean}.
  *
  * @author Christoph Strobl
+ * @author Hyunsang Han
  */
 class MongoClientFactoryBeanUnitTests {
 
@@ -89,4 +92,26 @@ void hostAndPortPlusConnectionStringError() {
 		factoryBean.setPort(27017);
 		assertThatExceptionOfType(IllegalStateException.class).isThrownBy(factoryBean::createInstance);
 	}
+
+	@Test // GH-5037
+	void requiresExplicitUuidRepresentationConfiguration() {
+
+		MongoClientFactoryBean factoryBean = new MongoClientFactoryBean();
+		
+		assertThatThrownBy(factoryBean::computeClientSetting)
+				.isInstanceOf(IllegalStateException.class)
+				.hasMessageContaining("UUID representation must be explicitly configured");
+	}
+
+	@Test // GH-5037
+	void worksWithExplicitUuidRepresentationConfiguration() {
+
+		MongoClientFactoryBean factoryBean = new MongoClientFactoryBean();
+		factoryBean.setMongoClientSettings(
+				MongoClientSettings.builder().uuidRepresentation(UuidRepresentation.STANDARD).build());
+
+		MongoClientSettings settings = factoryBean.computeClientSetting();
+
+		assertThat(settings.getUuidRepresentation()).isEqualTo(UuidRepresentation.STANDARD);
+	}
 }