Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BigDecimal.parseString("") returns ZERO instead of throwing #253

Closed
okarmazin opened this issue Feb 2, 2023 · 6 comments · Fixed by #255
Closed

BigDecimal.parseString("") returns ZERO instead of throwing #253

okarmazin opened this issue Feb 2, 2023 · 6 comments · Fixed by #255
Assignees

Comments

@okarmazin
Copy link

Empty string is not a valid representation of a decimal number and should not be accepted.

https://github.com/ionspin/kotlin-multiplatform-bignum/blob/main/bignum/src/commonMain/kotlin/com/ionspin/kotlin/bignum/decimal/BigDecimal.kt#L899..L901

@ionspin ionspin self-assigned this Feb 2, 2023
@ionspin
Copy link
Owner

ionspin commented Feb 2, 2023

Thanks for reporting!

ionspin added a commit that referenced this issue Feb 11, 2023
…r any more, fixes #253. Added bitLength to BigInteger/BitwiseCapable API, supersedes #254. Removed unneccessary annotations in json support library.
@Lysander
Copy link

Empty string is not a valid representation of a decimal number and should not be accepted.

This might be correct in a mathematcical sense, but it totally ignores the reality of parsing!

It is very common in the context of data handling to omit 0s in data representations like CSV or alike. So imho you can ask 100 people and more than 99 would answer that zero should be the equivalent when converting "nothing".

Imho you should respect Postel's law here. Again: It is about parsing, not serialization!

At least this should be marked as an serious behaviour chaning issue.

@okarmazin
Copy link
Author

Some of the reasoning is correct, but it's applied at incorrect place. If your domain requires handling of empty strings as zeroes, you need to apply your custom logic, e.g. replace empty input with zero, before you get to this method.

Zero is not special here. It is equally incorrect to return zero from an empty string as it would be to return Random.nextDouble. Your domain is special? Brilliant, then apply your domain logic at the domain level.

@Lysander
Copy link

You are right: Zero is not special in the domain of parsing ;-) So I consider this to be a part of the convenient user API of this lib.

Let's commit, that we have different opinions of this topic.

Then let us just step aside from wrong or right and try to focus on the API of a library and the constraints and responsabilities it has: Imho as a maintainer you are resonsible to keep the API (including behaviour!) as stable as you can. This was a huge change and imho it would have been better to balance pros and cons more carefully.

The consequence of your observation is: Someone who needs to be aware of empty strings would have to encode special code before calling this function.

Now the other way round is needed - as I proclaim: The waste majority would have to change this now!

Let us recap other alternatives:

  • it would have been possible to add some strict mode like parseStringStrictly -> solution for all mathematics
  • it would be possible to add some "error handling strategy" like the .NET does for Charset encoding iirc. parseString(..., ..., errorHandle: ErrorHandle), where the default is either "make zero" or "throw exception" depending on the stand-point.
  • or quite similar to above but perhaps more kotlinesque: parseStringOrDefault and/or parseStringOrElse

To be fair: Obviously noone besides me cared about this change, even though it is much more severe than the fixing procedure would unveil ;-)

@ionspin
Copy link
Owner

ionspin commented Mar 21, 2024

Hello @Lysander,

Thank you for your opinion on this topic, while I disagree with you on most points, I can understand that it can be irritating when something that was working suddenly breaks. Unfortunately in this case I agree completely with @okarmazin, the solution should be applied at the domain level.

Once again, thanks for the opinions!

@Lysander
Copy link

Lysander commented Mar 21, 2024

Thanks for the overall excellent library ;-)

No problem - let's embrace different opinions discussed without harm or even violence. There is inherent value in this - especially nowadays :-)

@Lysander Lysander mentioned this issue Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants