tests(math): fix zero value test

[kocubinski]

Description

Minor clean up on #21806, use MarshalJSON instead of String() since it's more clear on nil values.

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title, you can find examples of the prefixes below:
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• Bug Fixes
  • Improved the accuracy of JSON serialization for decimal values, enhancing validation of equality between zero and empty decimals.
  • Added error handling for the marshaling process to catch and report serialization issues.

[coderabbitai]

Walkthrough

Walkthrough

The changes involve modifying the Test_DocumentLegacyAsymmetry function in the math/dec_test.go file. The update shifts the serialization method for zeroDec and emptyDec instances from the String() method to the MarshalJSON() method. This adjustment aims to improve the accuracy of JSON representations and includes enhanced error handling for the marshaling process.

Changes

File	Change Summary
math/dec_test.go	Updated Test_DocumentLegacyAsymmetry to use MarshalJSON() for serializing zeroDec and emptyDec instances, improving JSON representation accuracy and adding error handling.

Possibly related PRs

• tests(math): document unexpected behavior in nil values #21806: Introduces the Test_DocumentLegacyAsymmetry function in the same file, related to the changes in serialization for decimal instances.

Suggested reviewers

• alpe
• testinginprod
• tac0turtle
• julienrbrt

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between bdda21f and 859a215.

Files selected for processing (1)

• math/dec_test.go (2 hunks)

Additional context used

Path-based instructions (1)

math/dec_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

---

Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Additional comments not posted (1)

math/dec_test.go (1)

1035-1036: Test logic looks good! The asymmetry bug is correctly identified.

The test does a great job at demonstrating the asymmetry between zero and empty LegacyDec values when marshaling and unmarshaling.

The key finding is:

• For zeroDec, marshaling and unmarshaling is symmetrical. The original and unmarshaled JSON representations match.
• However, for emptyDec, marshaling and unmarshaling is asymmetrical. The original and unmarshaled JSON representations do not match.

This asymmetry seems unintended and is correctly flagged as a potential bug. Great catch!

Also applies to: 1040-1041, 1052-1054, 1061-1063, 1065-1066

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.