Configure ObjectMapper to serialize BigDecimal as String

[Blackbaud-JasonBodnar]

Configure ObjectMapper to serialize BigDecimal as String so precision and scale are maintained, especially when value ends in 0s (#38691)

Description

As described in #38691, BigDecimal values ending in 0 (ie, 123.40) lose the trailing 0 when saved to the database. When the value is retrieved originalValue.equals(retrivedValue) fails because BigDecimal.equals() takes into account precision and scale and 123.40 does not have the same scale as 123.4.

This is fixed by configure the ObjectMapper to serialize BigDecimal as a String instead of a Number using JsonFormat.Value.forShape(JsonFormat.Shape.STRING).

JsonFormat is only used for serialization so this change is backwards compatible allowing existing values saved as Number to still be deserialized properly.

All SDK Contribution checklist:

• [ X ] The pull request does not introduce [breaking changes]
• CHANGELOG is updated for new features, bug fixes or other significant changes.
• [ X ] I have read the contribution guidelines.

General Guidelines and Best Practices

• [ X ] Title of the pull request is clear and informative.
• [ X ] There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

• [ X ] Pull request includes test coverage for the included changes.

[github-actions]

Thank you for your contribution @Blackbaud-JasonBodnar! We will review the pull request and get back to you soon.

[Blackbaud-JasonBodnar]

@microsoft-github-policy-service agree company=Blackbaud Sensitivity: Public

…

________________________________ From: microsoft-github-policy-service[bot] ***@***.***> Sent: Tuesday, March 19, 2024 6:30 PM To: Azure/azure-sdk-for-java ***@***.***> Cc: Jason Bodnar ***@***.***>; Mention ***@***.***> Subject: Re: [Azure/azure-sdk-for-java] Configure ObjectMapper to serialize BigDecimal as String (PR #39302) @Blackbaud-JasonBodnar<https://github.com/Blackbaud-JasonBodnar> please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information. @microsoft-github-policy-service agree [company="{your company}"] Options: * (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer. @microsoft-github-policy-service agree * (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer. @microsoft-github-policy-service agree company="Microsoft" Contributor License Agreement Contribution License Agreement This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”), and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your contributions to Microsoft open source projects. This Agreement is effective as of the latest signature date below. 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, that is delivered by You to Microsoft under this Agreement. “Project” means any of the projects owned or managed by Microsoft and offered under a license approved by the Open Source Initiative (www.opensource.org<http://www.opensource.org>). “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any Project, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of discussing and improving that Project, but excluding communication that is conspicuously marked or otherwise designated in writing by You as “Not a Submission.” “Submission” means the Code and any other copyrightable material Submitted by You, including any associated comments and documentation. 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any Project. This Agreement covers any and all Submissions that You, now or in the future (except as described in Section 4 below), Submit to any Project. 3. Originality of Work. You represent that each of Your Submissions is entirely Your original work. Should You wish to Submit materials that are not Your original work, You may Submit them separately to the Project if You (a) retain all copyright and license information that was in the materials as You received them, (b) in the description accompanying Your Submission, include the phrase “Submission containing materials of a third party:” followed by the names of the third party and any licenses or other restrictions of which You are aware, and (c) follow any other instructions in the Project’s written guidelines concerning Submissions. 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your Submission is made in the course of Your work for an employer or Your employer has intellectual property rights in Your Submission by contract or applicable law, You must secure permission from Your employer to make the Submission before signing this Agreement. In that case, the term “You” in this Agreement will refer to You and the employer collectively. If You change employers in the future and desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement and secure permission from the new employer before Submitting those Submissions. 5. Licenses. * Copyright License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third parties. * Patent License. You grant Microsoft, and those who receive the Submission directly or indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under Your patent claims that are necessarily infringed by the Submission or the combination of the Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and import or otherwise dispose of the Submission alone or with the Project. * Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are granted by implication, exhaustion, estoppel or otherwise. 1. Representations and Warranties. You represent that You are legally entitled to grant the above licenses. You represent that each of Your Submissions is entirely Your original work (except as You may have disclosed under Section 3). You represent that You have secured permission from Your employer to make the Submission in cases where Your Submission is made in the course of Your work for Your employer or Your employer has intellectual property rights in Your Submission by contract or applicable law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You have the necessary authority to bind the listed employer to the obligations contained in this Agreement. You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE. 2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which You later become aware that would make Your representations in this Agreement inaccurate in any respect. 3. Information about Submissions. You agree that contributions to Projects and information about contributions may be maintained indefinitely and disclosed publicly, including Your name and other information that You submit with Your Submission. 4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County, Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all defenses of lack of personal jurisdiction and forum non-conveniens. 5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft. — Reply to this email directly, view it on GitHub<#39302 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ABGXM6I6JEFCQZ75YBLKD3TYZDC77AVCNFSM6AAAAABE6PRJD6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAMBYGMZTQOJUHA>. You are receiving this because you were mentioned.Message ID: ***@***.***>

[FabianMeiswinkel]

Hi @Blackbaud-JasonBodnar - thanks for providing this PR - really appreciated. I do not think we can just change the ObjectMapper settings in the ObjectMapperFactory - your argument that this won't break as long as someone uses Java and Jackson is true - but within a workload custoemrs could easily also use other clients/SDKs with different serializers - and changing the json from number to string (while I agree is the best option to deal with the challenges around json numbers in many cases) might not be acceptable for everyone. Since this technically is a breaking change it could not be done by default. I am working right now on a change in azure-cosmos allowing to provide custom serialization logic - I hope to have a PR out later this week or early next week and will make sure I also add integration test coverage for the BigDecimal use case. I think it might make sense to use the same approach. Can we delay making a final decision for this PR until I have this PR out?

[Blackbaud-JasonBodnar]

@FabianMeiswinkel : Custom serialization is not the solution. If you go to the original bug as a consumer of a database and a high level SDK, I should not have to be concerned or have any knowledge of how my data is serialized. What I get out of a database should equal what I put in without any configuration on my part.

[kushagraThapar]

@Blackbaud-JasonBodnar - re-opening this thread. Custom serialization functionality has been added to the Cosmos Java SDK and we think it is the best possible way (lesser of all the evils) to solve this issue.
FYI, I also read this thread which talks about the same problem with jackson - FasterXML/jackson-databind#2087. It has some more information on how to unblock this with some other workarounds.
Nevertheless, as @FabianMeiswinkel mentioned above, we don't think just changing the default object mapper of the Cosmos Java SDK library by default is the correct way to go here, can you please take a look at the custom serialization mechanism and see if it solves your use case.

Here are the changes for custom serialization - https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/cosmos/azure-cosmos/CHANGELOG.md#4590-2024-04-27

[Blackbaud-JasonBodnar]

@kushagraThapar You already have the ability to provide a custom ObjectMapper in azure-spring-data-cosmos. I'm currently using it to work around the BigDecimal issue:

@Configuration
@Order(Ordered.HIGHEST_PRECEDENCE)
public class ObjectMapperConfig {
    @Bean
    @Qualifier(Constants.OBJECT_MAPPER_BEAN_NAME)
    public ObjectMapper cosmosObjectMapper() {
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper
                .registerModule(new ParameterNamesModule())
                .registerModule(new Jdk8Module())
                .registerModule(new JavaTimeModule())
                .configure(SerializationFeature.WRITE_DATES_WITH_ZONE_ID, true)
                .configure(JsonGenerator.Feature.WRITE_BIGDECIMAL_AS_PLAIN, true)
                .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
                .configOverride(BigDecimal.class).setFormat(JsonFormat.Value.forShape(JsonFormat.Shape.STRING));
        return objectMapper;
    }
}

The PR you linked to will certainly help people accessing Cosmos via the SDK without Spring. But I don't think either that or the current workaround I'm using address the two issues I have:

1. As the consumer of a NOSQL database I shouldn't be concerned with how my data is formatted.
2. When I insert a document into a NOSQL database if I retrieve the document it should equal the document I inserted (except for auto-populated fields such as id, auditable fields, etc).

Requiring a consumer of the SDK to provide a custom object mapper breaks those two issues. And while I understand you don't want to change the default behavior of the existing object mapper, that's what major versions are for -- breaking functionality. Considering that the existing object mapper is broken with respect to BigDecimal it would not be out of the question to have a major version release that changes existing functionality in order to fix something.

[FabianMeiswinkel]

@Blackbaud-JasonBodnar - if and when we release a new major version, I indeed think that this is something we should take a close look at. But new major versions come with a very high cost for us - all Azure SDKs are required to keep supporting previous major versions for at least 3 years - so, introducing a new major version is the last possible option we would look into - it would need to be necessary to provide very significant added value to justify the maintenance cost for supporting two major version for >3 years. And the last major version has also shown us that most customers are not eager to adopt an SDK with breaking changes. So, supporting BigDecimals out-of-the-box is something we can and will take a look at when we have to make a breaking change to a new major version - but for sure not sufficient motivation to publish a new major version.

[github-actions]

Hi @Blackbaud-JasonBodnar. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

[kushagraThapar]

@Blackbaud-JasonBodnar circling back on this, I am curious if you want to discuss this further or can we close this?

[Blackbaud-JasonBodnar]

@Blackbaud-JasonBodnar circling back on this, I am curious if you want to discuss this further or can we close this?

I've said what I had to say. We've worked around this bug but I really don't think we should have to. I've given you a PR to fix the issue. Since I don't control the repo this is all I can do unless I want to fork it and go on my own.

[alzimmermsft]

Hi @Blackbaud-JasonBodnar, overall, the concept of this change looks good to me but I'd recommend putting this feature behind a configuration flag that is checked at the start of runtime. We cannot be certain how this code is used elsewhere and changing the JSON output from a numeric field to a string field could break other customers. So, making this something that needs to be opted into would be best to retain existing behavior while also being able to fix this issue for others running into this same problem.

Adding some details on to the issue that was filed which prompted this PR. Using ObjectMapper.readTree(String) may opt into using double as the default over BigDecimal due to performance reasons, which leads me to believe that if the JSON string was being converted to a specific object where that JSON field was a BigDecimal you wouldn't be seeing this loss of precision.

https://github.com/FasterXML/jackson-core/blob/2.18/src/main/java/com/fasterxml/jackson/core/base/ParserBase.java#L770
https://github.com/FasterXML/jackson-core/blob/2.18/src/main/java/com/fasterxml/jackson/core/base/ParserBase.java#L988
https://github.com/FasterXML/jackson-databind/blob/2.18/src/main/java/com/fasterxml/jackson/databind/DeserializationFeature.java#L49

[kushagraThapar]

Thanks @alzimmermsft and @saragluna for the review and providing further suggestions.

@Blackbaud-JasonBodnar if and when you get some time, can you please add a flag in the application.properties which will allow us to make this an opt-in.
Let us know if you have any questions, thanks for your patience and taking this forward :)

[Blackbaud-JasonBodnar]

@kushagraThapar : I'll take a crack at making this configurable, but it probably won't happen for at least a week or two.

[kushagraThapar]

@kushagraThapar : I'll take a crack at making this configurable, but it probably won't happen for at least a week or two.

@Blackbaud-JasonBodnar thanks, I think it works best with our release schedule as well. If you don't get time, let me know and I can take this forward as well, just don't want to overstep on your toes here.

[github-actions]

Hi @Blackbaud-JasonBodnar. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

[kushagraThapar]

@trande4884 can you please take this feature forward?

[github-actions]

Hi @Blackbaud-JasonBodnar. Thank you for your interest in helping to improve the Azure SDK experience and for your contribution. We've noticed that there hasn't been recent engagement on this pull request. If this is still an active work stream, please let us know by pushing some changes or leaving a comment. Otherwise, we'll close this out in 7 days.

[github-actions]

Hi @Blackbaud-JasonBodnar. Thank you for your contribution. Since there hasn't been recent engagement, we're going to close this out. Feel free to respond with a comment containing /reopen if you'd like to continue working on these changes. Please be sure to use the command to reopen or remove the no-recent-activity label; otherwise, this is likely to be closed again with the next cleanup pass.