ConvertTo-Json: Serialize BigInteger as a number #21000

jborean93 · 2024-01-05T00:52:31Z

PR Summary

Serializes a BigInteger value as a raw JSON number rather than the object's properties which does not contain the BigInteger value.

This is technically a breaking change, I went ahead with the PR anyway to see if it was actually possible to do (it is). Waiting for the triage outcome of #20989 (comment) to see if this breaking change is ok or not.

PR Context

Fixes: #20989

PR Checklist

Serializes a BigInteger value as a raw JSON number rather than the object's properties which does not contain the BigInteger value.

iSazonov · 2024-01-05T06:15:40Z

src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/JsonObject.cs

@@ -519,6 +520,10 @@ private static object ProcessValue(object obj, int currentDepth, in ConvertToJso
            {
                rv = jObject.ToObject<Dictionary<object, object>>();
            }
+            else if (obj is BigInteger bi)
+            {
+                rv = new JRaw(bi.ToString(NumberFormatInfo.InvariantInfo));


Why do we need JRaw?

So the value isn’t quoted and is a literal numeric value.

Perhaps we should use string if we agree with #20999 (comment)

Personally I don't see why we should but I'll leave it up to the WG decision in the end.

If they do decide to quote BigIntegers so then it should only happen if the value is larger than the Javascript precision value. I would have to say I really don’t think it’s a good idea as it complicates the cmdlet even more.

Turns out it isn't needed we just need to ensure the value is the BigInteger itself and we don't do PowerShell's property enumerator.

pull-request-quantifier-deprecated · 2024-01-05T10:05:25Z

This PR has 10 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details

Label      : Extra Small
Size       : +9 -1
Percentile : 4%

Total files changed: 2

Change summary by file extension:
.cs : +3 -1
.ps1 : +6 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

Fast and predictable releases to production:
- Optimal size changes are more likely to be reviewed faster with fewer
  iterations.
- Similarity in low PR complexity drives similar review times.
Review quality is likely higher as complexity is lower:
- Bugs are more likely to be detected.
- Code inconsistencies are more likely to be detected.
Knowledge sharing is improved within the participants:
- Small portions can be assimilated better.
Better engineering practices are exercised:
- Solving big problems by dividing them in well contained, smaller problems.
- Exercising separation of concerns within the code changes.

What can I do to optimize my changes

Use the PullRequestQuantifier to quantify your PR accurately
- Create a context profile for your repo using the context generator
- Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
- Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
- Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
Change your engineering behaviors
- For PRs that fall outside of the desired spectrum, review the details and check if:
  - Your PR could be split in smaller, self-contained PRs instead
  - Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

One line was added: +1 -0
One line was deleted: +0 -1
One line was modified: +1 -1 (git diff doesn't know about modified, it will
interpret that line like one addition plus one deletion)
Change percentiles: Change characteristics (addition, deletion, modification)
of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍 :ok_hand: :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

SteveL-MSFT · 2024-02-21T17:46:08Z

The WG agrees that the same reasoning in #20999 (comment) applies here

SeeminglyScience

LGTM! Thanks @jborean93!

microsoft-github-policy-service · 2024-02-27T22:53:08Z

📣 Hey @jborean93, how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://aka.ms/PSRepoFeedback

Microsoft Forms

ConvertTo-Json: Serialize BigInteger as a number

162dff4

Serializes a BigInteger value as a raw JSON number rather than the object's properties which does not contain the BigInteger value.

pull-request-quantifier-deprecated bot added the Extra Small label Jan 5, 2024

jborean93 mentioned this pull request Jan 5, 2024

Serializing bigint value to JSON emits incorrect JSON #20989

Closed

5 tasks

iSazonov reviewed Jan 5, 2024

View reviewed changes

Serialize as a normal object

a22405e

iSazonov approved these changes Jan 9, 2024

View reviewed changes

iSazonov assigned daxian-dbw Jan 9, 2024

microsoft-github-policy-service bot added the Review - Needed The PR is being reviewed label Jan 16, 2024

microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Feb 21, 2024

SteveL-MSFT added Review - Needed The PR is being reviewed WG-Reviewed A Working Group has reviewed this and made a recommendation and removed WG-NeedsReview Needs a review by the labeled Working Group labels Feb 21, 2024

microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Feb 21, 2024

SeeminglyScience approved these changes Feb 26, 2024

View reviewed changes

daxian-dbw merged commit fcf4953 into PowerShell:master Feb 27, 2024
38 checks passed

jborean93 deleted the json-biginteger branch February 27, 2024 23:01

Apr	MAY	Jun
	25
2023	2024	2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ConvertTo-Json: Serialize BigInteger as a number #21000

ConvertTo-Json: Serialize BigInteger as a number #21000

jborean93 commented Jan 5, 2024

iSazonov Jan 5, 2024

jborean93 Jan 5, 2024

iSazonov Jan 5, 2024

jborean93 Jan 5, 2024 •

edited

jborean93 Jan 5, 2024

pull-request-quantifier-deprecated bot commented Jan 5, 2024

What can I do to optimize my changes

How to interpret the change counts in git diff output

SteveL-MSFT commented Feb 21, 2024

SeeminglyScience left a comment

microsoft-github-policy-service bot commented Feb 27, 2024 •

edited by unfurl-links bot

ConvertTo-Json: Serialize BigInteger as a number #21000

ConvertTo-Json: Serialize BigInteger as a number #21000

Conversation

jborean93 commented Jan 5, 2024

PR Summary

PR Context

PR Checklist

iSazonov Jan 5, 2024

Choose a reason for hiding this comment

jborean93 Jan 5, 2024

Choose a reason for hiding this comment

iSazonov Jan 5, 2024

Choose a reason for hiding this comment

jborean93 Jan 5, 2024 • edited

Choose a reason for hiding this comment

jborean93 Jan 5, 2024

Choose a reason for hiding this comment

pull-request-quantifier-deprecated bot commented Jan 5, 2024

What can I do to optimize my changes

How to interpret the change counts in git diff output

SteveL-MSFT commented Feb 21, 2024

SeeminglyScience left a comment

Choose a reason for hiding this comment

microsoft-github-policy-service bot commented Feb 27, 2024 • edited by unfurl-links bot

jborean93 Jan 5, 2024 •

edited

microsoft-github-policy-service bot commented Feb 27, 2024 •

edited by unfurl-links bot