feat(math): Upstream GDA based decimal type - marshal/unmarshal #21016

samricotta · 2024-07-22T09:32:12Z

Description

Closes: #XXXX

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

coderabbitai · 2024-07-22T09:32:20Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

🗂️ Base branches to auto review (1)

main

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

🪧 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.

aaronc

What are the rules for when e notation is or isn't used in marshaling? We should be explicit about that... at the risk of writing custom string formatting logic on top of apd

samricotta · 2024-07-24T12:22:36Z

@aaronc ive added in a couple of more tests, let me know if this is suffice. Ive also added in more godocs around restraints and strange behaviour. This less effects unmarshaling

aaronc · 2024-07-24T12:43:04Z

math/dec.go

-func (d Dec) Marshal() ([]byte, error) {
-	return d.dec.MarshalText()
+// The output may be in scientific notation if the number's magnitude is very large or very small.
+// Specifically, scientific notation is used for numbers with an absolute value >= 1e6 or < 1e-5.


If this is used for token values it might be somewhat non-intuitive as these often at least 6 or 9 digits. What are we optimizing for here? Storage space or human readability?

hmm yes good point. Client libraries would have to handle this notation, too when submitted as json. What do you suggest here re format?

alpe

Good tests!
I am not sure when it is decimal or scientific notation.

alpe · 2024-07-30T11:57:27Z

math/dec_test.go

+		},
+		"1e100000": {
+			x:   NewDecWithPrec(1, 100_000),
+			exp: "1E+100000",


here and others: I was expecting `"100000000000..." not the scientific notation.

alpe · 2024-07-30T11:58:53Z

math/dec_test.go

+			exp: "123456",
+		},
+		"Trailing zeros": {
+			x:   "1.23456E+8",


there are no trailing 0 in this example. Something like this 1.00000 or 1.10000 would work

math/dec_test.go

alpe · 2024-07-30T12:02:00Z

math/dec_test.go

+			x:   "1.23456e+8",
+			exp: "123456000",
+		},
+		"Zero value": {


Would be good to include -0 as an edge case in the test spec

alpe · 2024-07-30T12:03:12Z

math/dec_test.go

+		exp    string
+		expErr error
+	}{
+		"No trailing zeros": {


How about testing leading zeros instead? for example 0123

alpe · 2024-07-30T12:06:32Z

math/dec.go

-func (d *Dec) Unmarshal(data []byte) error {
-	return d.dec.UnmarshalText(data)
+func (x *Dec) Unmarshal(data []byte) error {
+	var d apd.Decimal


would it make sense to use our string constructor instead? We have a lot of checks there already.

math/dec.go

aaronc · 2024-07-30T13:17:26Z

math/dec.go

+		return ErrInvalidDec.Wrap("not a number")
+	case apd.Infinite:
+		return ErrInvalidDec.Wrap("infinite decimal value not allowed")
+	default:


The success case should probably be apd.Finite, with default: actually being an error for unknown form

github-actions · 2024-08-31T00:05:45Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions · 2024-10-01T00:07:21Z

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

marshall/unmarshall

bd4c5cb

samricotta requested a review from a team as a code owner July 22, 2024 09:32

samricotta assigned alpe Jul 22, 2024

remove tests that are from deleted constraints

15fc0ef

samricotta assigned aaronc Jul 23, 2024

aaronc reviewed Jul 23, 2024

View reviewed changes

update godocs and add more tests

16f5b25

aaronc reviewed Jul 24, 2024

View reviewed changes

pure decimal changes

bf25586

alpe reviewed Jul 30, 2024

View reviewed changes

aaronc reviewed Jul 30, 2024

View reviewed changes

updates on using scientific notation

7ede82f

github-actions bot added the Stale label Aug 31, 2024

julienrbrt removed the Stale label Aug 31, 2024

github-actions bot added the Stale label Oct 1, 2024

tac0turtle closed this Oct 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(math): Upstream GDA based decimal type - marshal/unmarshal #21016

feat(math): Upstream GDA based decimal type - marshal/unmarshal #21016

samricotta commented Jul 22, 2024

coderabbitai bot commented Jul 22, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

aaronc left a comment

samricotta commented Jul 24, 2024

aaronc Jul 24, 2024

samricotta Jul 25, 2024

alpe left a comment

alpe Jul 30, 2024

alpe Jul 30, 2024

alpe Jul 30, 2024

alpe Jul 30, 2024

alpe Jul 30, 2024

aaronc Jul 30, 2024

github-actions bot commented Aug 31, 2024

github-actions bot commented Oct 1, 2024

feat(math): Upstream GDA based decimal type - marshal/unmarshal #21016

feat(math): Upstream GDA based decimal type - marshal/unmarshal #21016

Conversation

samricotta commented Jul 22, 2024

Description

Author Checklist

Reviewers Checklist

coderabbitai bot commented Jul 22, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

aaronc left a comment

Choose a reason for hiding this comment

samricotta commented Jul 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alpe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Aug 31, 2024

github-actions bot commented Oct 1, 2024

coderabbitai bot commented Jul 22, 2024 •

edited

Loading