Configure ObjectMapper to serialize BigDecimal as String

sdk/spring/azure-spring-data-cosmos/pom.xml

@@ -39,6 +39,7 @@
       --add-opens com.azure.spring.data.cosmos/com.azure.spring.data.cosmos.domain=com.fasterxml.jackson.databind,spring.core,spring.data.commons
       --add-opens com.azure.spring.data.cosmos/com.azure.spring.data.cosmos.domain.inheritance=com.fasterxml.jackson.databind,spring.core,spring.data.commons
       --add-opens com.fasterxml.jackson.databind/com.fasterxml.jackson.databind=spring.core
+      --add-opens java.base/java.math=ALL-UNNAMED,spring.core
     </javaModulesSurefireArgLine>
     <azure.test.resourcegroup>azure-spring-data-cosmos-test</azure.test.resourcegroup>
     <azure.test.dbname>testdb-${maven.build.timestamp}</azure.test.dbname>

sdk/spring/azure-spring-data-cosmos/src/main/java/com/azure/spring/data/cosmos/core/convert/ObjectMapperFactory.java

@@ -3,12 +3,15 @@
 
 package com.azure.spring.data.cosmos.core.convert;
 
+import com.fasterxml.jackson.annotation.JsonFormat;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
 import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
 
+import java.math.BigDecimal;
+
 /**
  * Factory class for object mapper
  */
@@ -17,9 +20,10 @@ public class ObjectMapperFactory {
 
     static {
         OBJECT_MAPPER.registerModule(new ParameterNamesModule())
-                        .registerModule(new Jdk8Module())
-                        .registerModule(new JavaTimeModule());
-        OBJECT_MAPPER.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+            .registerModule(new Jdk8Module())
+            .registerModule(new JavaTimeModule())
+            .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
+            .configOverride(BigDecimal.class).setFormat(JsonFormat.Value.forShape(JsonFormat.Shape.STRING));
     }
 
     /**

sdk/spring/azure-spring-data-cosmos/src/test/java/com/azure/spring/data/cosmos/common/TestConstants.java

@@ -5,6 +5,7 @@
 import com.azure.cosmos.models.IndexingMode;
 import com.azure.spring.data.cosmos.domain.Address;
 
+import java.math.BigDecimal;
 import java.time.LocalDate;
 import java.util.Arrays;
 import java.util.HashMap;
@@ -113,6 +114,9 @@ public final class TestConstants {
     public static final String PROPERTY_CITY = "city";
     public static final String PROPERTY_STREET = "street";
 
+    public static final String PROPERTY_AMOUNT = "amount";
+    public static final BigDecimal BIG_DECIMAL_VALUE = new BigDecimal("123.40");
+
     public static final int PAGE_SIZE_1 = 1;
     public static final int PAGE_SIZE_2 = 2;
     public static final int PAGE_SIZE_3 = 3;

sdk/spring/azure-spring-data-cosmos/src/test/java/com/azure/spring/data/cosmos/core/converter/MappingCosmosConverterUnitTest.java

@@ -9,6 +9,7 @@
 import com.azure.spring.data.cosmos.domain.Address;
 import com.azure.spring.data.cosmos.domain.Importance;
 import com.azure.spring.data.cosmos.domain.Memo;
+import com.azure.spring.data.cosmos.domain.ObjectWithBigDecimal;
 import com.azure.spring.data.cosmos.domain.Person;
 import com.azure.spring.data.cosmos.domain.PersonWithEtag;
 import com.fasterxml.jackson.databind.JsonNode;
@@ -21,6 +22,7 @@
 import org.mockito.junit.MockitoJUnitRunner;
 import org.springframework.context.ApplicationContext;
 
+import java.math.BigDecimal;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
@@ -41,7 +43,7 @@ public class MappingCosmosConverterUnitTest {
     @Before
     public void setUp() {
         final CosmosMappingContext mappingContext = new CosmosMappingContext();
-        final ObjectMapper objectMapper = new ObjectMapper();
+        final ObjectMapper objectMapper = ObjectMapperFactory.getObjectMapper();
 
         mappingContext.setApplicationContext(applicationContext);
         mappingContext.afterPropertiesSet();
@@ -153,5 +155,26 @@ public void mapsDefaultEtag() {
 
         assertThat(jsonNode.get(TestConstants.PROPERTY_ETAG_DEFAULT).asText()).isEqualTo(etagValue);
     }
+
+    @Test
+    public void convertsBigDecimalAsString() {
+        final ObjectWithBigDecimal object = new ObjectWithBigDecimal(TestConstants.ID_1, TestConstants.BIG_DECIMAL_VALUE);
+
+        final JsonNode jsonNode = mappingCosmosConverter.writeJsonNode(object);
+
+        assertThat(new BigDecimal(jsonNode.get(TestConstants.PROPERTY_AMOUNT).asText())).isEqualTo(TestConstants.BIG_DECIMAL_VALUE);
+    }
+
+    @Test
+    public void deserializesExistingNumberBigDecimalCorrectly() {
+        final ObjectNode objectNode = ObjectMapperFactory.getObjectMapper().createObjectNode();
+        objectNode.put(TestConstants.PROPERTY_ID, TestConstants.ID_1);
+        objectNode.put(TestConstants.PROPERTY_AMOUNT, TestConstants.BIG_DECIMAL_VALUE.doubleValue());
+
+        final ObjectWithBigDecimal object = mappingCosmosConverter.read(ObjectWithBigDecimal.class, objectNode);
+
+        assertThat(object.getAmount().doubleValue()).isEqualTo(TestConstants.BIG_DECIMAL_VALUE.doubleValue());
+    }
 }
 
+

sdk/spring/azure-spring-data-cosmos/src/test/java/com/azure/spring/data/cosmos/domain/ObjectWithBigDecimal.java

@@ -0,0 +1,72 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package com.azure.spring.data.cosmos.domain;
+
+import com.azure.spring.data.cosmos.common.TestConstants;
+import com.azure.spring.data.cosmos.core.mapping.Container;
+import com.azure.spring.data.cosmos.core.mapping.CosmosIndexingPolicy;
+
+import java.math.BigDecimal;
+import java.util.Objects;
+
+@Container(ru = TestConstants.DEFAULT_MINIMUM_RU)
+@CosmosIndexingPolicy()
+public class ObjectWithBigDecimal {
+    private String id;
+    private BigDecimal amount;
+
+    public ObjectWithBigDecimal(String id, BigDecimal amount) {
+        this.id = id;
+        this.amount = amount;
+    }
+
+    public ObjectWithBigDecimal() {
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public void setId(String id) {
+        this.id = id;
+    }
+
+    public BigDecimal getAmount() {
+        return amount;
+    }
+
+    public void setAmount(BigDecimal amount) {
+        this.amount = amount;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        if (this == o) {
+            return true;
+        }
+        if (o == null || getClass() != o.getClass()) {
+            return false;
+        }
+        ObjectWithBigDecimal object = (ObjectWithBigDecimal) o;
+        return Objects.equals(id, object.id)
+            && Objects.equals(amount, object.amount);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(id, amount);
+    }
+
+    @Override
+    public String toString() {
+        return "Person{"
+            + "id='"
+            + id
+            + '\''
+            + ", amount='"
+            + amount
+            + '\''
+            + '}';
+    }
+}