Require explicit BigDecimal representation configuration

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

Author: HyunSangHan

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

@@ -61,6 +61,7 @@
  *
  * @author Mark Paluch
  * @author Christoph Strobl
+ * @author Hyunsang Han
  * @since 2.0
  * @see org.springframework.data.convert.CustomConversions
  * @see org.springframework.data.mapping.model.SimpleTypeHolder
@@ -159,7 +160,7 @@ public static class MongoConverterConfigurationAdapter {
 		private static final Set<Class<?>> JAVA_DRIVER_TIME_SIMPLE_TYPES = Set.of(LocalDate.class, LocalTime.class, LocalDateTime.class);
 
 		private boolean useNativeDriverJavaTimeCodecs = false;
-		private BigDecimalRepresentation bigDecimals = BigDecimalRepresentation.DECIMAL128;
+		private @Nullable BigDecimalRepresentation bigDecimals;
 		private final List<Object> customConverters = new ArrayList<>();
 
 		private final PropertyValueConversions internalValueConversion = PropertyValueConversions.simple(it -> {});
@@ -313,8 +314,8 @@ public MongoConverterConfigurationAdapter useSpringDataJavaTimeCodecs() {
 		}
 
 		/**
-		 * Configures the representation to for {@link java.math.BigDecimal} and {@link java.math.BigInteger} values in
-		 * MongoDB. Defaults to {@link BigDecimalRepresentation#DECIMAL128}.
+		 * Configures the representation for {@link java.math.BigDecimal} and {@link java.math.BigInteger} values in
+		 * MongoDB. This configuration is required and must be explicitly set.
 		 *
 		 * @param representation the representation to use.
 		 * @return this.
@@ -375,6 +376,10 @@ ConverterConfiguration createConverterConfiguration() {
 				svc.init();
 			}
 
+			if (bigDecimals == null) {
+				throw new IllegalStateException("BigDecimal representation must be explicitly configured.");
+			}
+
 			List<Object> converters = new ArrayList<>(STORE_CONVERTERS.size() + 7);
 
 			if (bigDecimals == BigDecimalRepresentation.STRING) {

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

@@ -123,6 +123,7 @@
  * @author Roman Puchkovskiy
  * @author Heesu Jung
  * @author Julia Lee
+ * @author Hyunsang Han
  */
 @ExtendWith(MockitoExtension.class)
 class MappingMongoConverterUnitTests {
@@ -135,8 +136,10 @@ class MappingMongoConverterUnitTests {
 	@BeforeEach
 	void beforeEach() {
 
-		MongoCustomConversions conversions = new MongoCustomConversions(
-				Arrays.asList(new ByteBufferToDoubleHolderConverter()));
+		MongoCustomConversions conversions = MongoCustomConversions.create(config -> {
+			config.bigDecimal(MongoCustomConversions.BigDecimalRepresentation.DECIMAL128);
+			config.registerConverter(new ByteBufferToDoubleHolderConverter());
+		});
 
 		mappingContext = new MongoMappingContext();
 		mappingContext.setApplicationContext(context);
@@ -414,6 +417,30 @@ void readsClassWithBigDecimal() {
 		assertThat(result.collection.get(0)).isEqualTo(BigDecimal.valueOf(2.5d));
 	}
 
+	@Test // GH-5037
+	void requiresExplicitBigDecimalRepresentationConfiguration() {
+
+		assertThatThrownBy(() -> {
+			MongoCustomConversions customConversions = new MongoCustomConversions(Collections.emptyList());
+			MappingMongoConverter converter = new MappingMongoConverter(mock(DbRefResolver.class), mappingContext);
+			converter.setCustomConversions(customConversions);
+		}).isInstanceOf(IllegalStateException.class)
+		  .hasMessageContaining("BigDecimal representation must be explicitly configured");
+	}
+
+	@Test // GH-5037
+	void worksWithExplicitBigDecimalRepresentationConfiguration() {
+
+		MongoCustomConversions customConversions = MongoCustomConversions.create(config -> {
+			config.bigDecimal(MongoCustomConversions.BigDecimalRepresentation.DECIMAL128);
+		});
+
+		MappingMongoConverter converter = new MappingMongoConverter(mock(DbRefResolver.class), mappingContext);
+		converter.setCustomConversions(customConversions);
+		assertThat(converter).isNotNull();
+		assertThat(converter.getCustomConversions()).isEqualTo(customConversions);
+	}
+
 	@Test
 	void writesNestedCollectionsCorrectly() {
 
@@ -3407,6 +3434,26 @@ void usesStringNumericFormat() {
 		assertThat(document).containsEntry("map.foo", "2.5");
 	}
 
+	@Test // GH-5037
+	void requiresExplicitConfigurationForBothBigDecimalAndUuid() {
+
+		MongoCustomConversions conversions = MongoCustomConversions.create(
+			it -> it.registerConverter(new ByteBufferToDoubleHolderConverter())
+					.bigDecimal(MongoCustomConversions.BigDecimalRepresentation.DECIMAL128));
+
+		assertThat(conversions).isNotNull();
+
+		assertThatThrownBy(() -> {
+			new MongoCustomConversions();
+		}).isInstanceOf(IllegalStateException.class)
+		.hasMessageContaining("BigDecimal representation must be explicitly configured");
+
+		assertThatThrownBy(() -> {
+			MongoCustomConversions.create(it -> it.registerConverter(new ByteBufferToDoubleHolderConverter()));
+		}).isInstanceOf(IllegalStateException.class)
+			.hasMessageContaining("BigDecimal representation must be explicitly configured");
+	}
+
 	private MappingMongoConverter createConverter(
 			MongoCustomConversions.BigDecimalRepresentation bigDecimalRepresentation) {
 

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

@@ -27,20 +27,24 @@
 import org.springframework.data.convert.PropertyValueConverter;
 import org.springframework.data.mapping.PersistentEntity;
 import org.springframework.data.mapping.PersistentProperty;
+import org.springframework.data.mongodb.core.convert.MongoCustomConversions.BigDecimalRepresentation;
 import org.springframework.data.mongodb.core.convert.QueryMapperUnitTests.Foo;
 
 /**
  * Unit tests for {@link MongoCustomConversions}.
  *
  * @author Christoph Strobl
+ * @author Hyunsang Han
  */
 class MongoCustomConversionsUnitTests {
 
 	@Test // DATAMONGO-2349
 	void nonAnnotatedConverterForJavaTimeTypeShouldOnlyBeRegisteredAsReadingConverter() {
 
-		MongoCustomConversions conversions = new MongoCustomConversions(
-				Collections.singletonList(new DateToZonedDateTimeConverter()));
+		MongoCustomConversions conversions = MongoCustomConversions.create(config -> {
+			config.bigDecimal(BigDecimalRepresentation.DECIMAL128);
+			config.registerConverter(new DateToZonedDateTimeConverter());
+		});
 
 		assertThat(conversions.hasCustomReadTarget(Date.class, ZonedDateTime.class)).isTrue();
 		assertThat(conversions.hasCustomWriteTarget(Date.class)).isFalse();
@@ -56,7 +60,7 @@ void propertyValueConverterRegistrationWorksAsExpected() {
 		when(owner.getType()).thenReturn(Foo.class);
 
 		MongoCustomConversions conversions = MongoCustomConversions.create(config -> {
-
+			config.bigDecimal(BigDecimalRepresentation.DECIMAL128);
 			config.configurePropertyConversions(
 					registry -> registry.registerConverter(Foo.class, "name", mock(PropertyValueConverter.class)));
 		});
@@ -68,12 +72,36 @@ void propertyValueConverterRegistrationWorksAsExpected() {
 	void doesNotReturnConverterForNativeTimeTimeIfUsingDriverCodec() {
 
 		MongoCustomConversions conversions = MongoCustomConversions.create(config -> {
+			config.bigDecimal(BigDecimalRepresentation.DECIMAL128);
 			config.useNativeDriverJavaTimeCodecs();
 		});
 
 		assertThat(conversions.getCustomWriteTarget(Date.class)).isEmpty();
 	}
 
+	@Test // GH-5037
+	void requiresExplicitBigDecimalRepresentationConfiguration() {
+
+		assertThatThrownBy(() -> {
+			MongoCustomConversions.create(config -> {
+				config.useSpringDataJavaTimeCodecs();
+			});
+		}).isInstanceOf(IllegalStateException.class)
+		  .hasMessageContaining("BigDecimal representation must be explicitly configured");
+	}
+
+	@Test // GH-5037
+	void worksWithExplicitBigDecimalRepresentationConfiguration() {
+
+		MongoCustomConversions conversions = MongoCustomConversions.create(config -> {
+			config.bigDecimal(BigDecimalRepresentation.DECIMAL128);
+			config.useSpringDataJavaTimeCodecs();
+		});
+
+		assertThat(conversions).isNotNull();
+		assertThat(conversions.getSimpleTypeHolder()).isNotNull();
+	}
+
 	static class DateToZonedDateTimeConverter implements Converter<Date, ZonedDateTime> {
 
 		@Override