Skip to content

ConvertTo-Json: Serialize BigInteger as a number - #21000

Merged
Dongbo Wang (daxian-dbw) merged 2 commits into
PowerShell:masterfrom
jborean93:json-biginteger
Feb 27, 2024
Merged

ConvertTo-Json: Serialize BigInteger as a number#21000
Dongbo Wang (daxian-dbw) merged 2 commits into
PowerShell:masterfrom
jborean93:json-biginteger

Conversation

@jborean93

@jborean93 Jordan Borean (jborean93) commented Jan 5, 2024

Copy link
Copy Markdown
Collaborator

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

@jborean93
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.
@jborean93 Jordan Borean (jborean93) mentioned this pull request Jan 5, 2024
Closed
5 tasks done
iSazonov
Ilya (iSazonov) reviewed Jan 5, 2024
View reviewed changes
Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/WebCmdlet/JsonObject.cs Outdated
}
else if (obj is BigInteger bi)
{
rv = new JRaw(bi.ToString(NumberFormatInfo.InvariantInfo));

@iSazonov Ilya (iSazonov) Jan 5, 2024

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we need JRaw?

@jborean93 Jordan Borean (jborean93) Jan 5, 2024

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@iSazonov Ilya (iSazonov) Jan 5, 2024

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@jborean93 Jordan Borean (jborean93) Jan 5, 2024 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@jborean93 Jordan Borean (jborean93) Jan 5, 2024

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn 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.

@iSazonov Ilya (iSazonov) added WG-Cmdlets-Utility CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log WG-NeedsReview Needs a review by the labeled Working Group Breaking-Change breaking change that may affect users CL-BreakingChange Indicates that a PR should be marked as a breaking change in the Change Log labels Jan 5, 2024
@pull-request-quantifier-deprecated

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

Copy link
Copy Markdown

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.

@microsoft-github-policy-service microsoft-github-policy-service Bot added the Review - Needed The PR is being reviewed label Jan 16, 2024
@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Feb 21, 2024

Copy link
Copy Markdown
Member

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

@microsoft-github-policy-service microsoft-github-policy-service Bot removed the Review - Needed The PR is being reviewed label Feb 21, 2024
@SteveL-MSFT Steve Lee (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 microsoft-github-policy-service Bot removed the Review - Needed The PR is being reviewed label Feb 21, 2024
SeeminglyScience
Patrick Meinecke (SeeminglyScience) approved these changes Feb 26, 2024
View reviewed changes

@SeeminglyScience Patrick Meinecke (SeeminglyScience) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks Jordan Borean (@jborean93)!

@daxian-dbw
Dongbo Wang (daxian-dbw) merged commit fcf4953 into PowerShell:master Feb 27, 2024
@jborean93
Jordan Borean (jborean93) deleted the json-biginteger branch February 27, 2024 23:01
Chris Dent (chrisdent-de) pushed a commit to chrisdent-de/PowerShell that referenced this pull request Sep 12, 2024
@jborean93 @chrisdent-de
ConvertTo-Json: Serialize BigInteger as a number (PowerShell#21000)
f270b6e
@gabriel-samfira Gabriel (gabriel-samfira) mentioned this pull request Dec 16, 2024
Closed
@andystaples andystaples mentioned this pull request Feb 27, 2026
Open
@kilasuit Ryan Yates (kilasuit) added WG-Cmdlets general cmdlet issues and removed WG-Cmdlets-Utility labels Jul 17, 2026
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@jborean93
ConvertTo-Json: Serialize BigInteger as a number (PowerShell#21000)
19a5acd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov Ilya (iSazonov) iSazonov approved these changes
@SeeminglyScience Patrick Meinecke (SeeminglyScience) SeeminglyScience approved these changes

Assignees

@daxian-dbw Dongbo Wang (daxian-dbw)

Labels

Breaking-Change breaking change that may affect users CL-BreakingChange Indicates that a PR should be marked as a breaking change in the Change Log CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small WG-Cmdlets general cmdlet issues WG-Reviewed A Working Group has reviewed this and made a recommendation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Serializing bigint value to JSON emits incorrect JSON

6 participants

@jborean93 @SteveL-MSFT @iSazonov @SeeminglyScience @daxian-dbw @kilasuit