Skip to content

encoding/json: add context during decoding when disallowUnknownFields is set #71638

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

encoding/json: add context during decoding when disallowUnknownFields is set #71638

wants to merge 2 commits into from

Conversation

machine424
Copy link

@machine424 machine424 commented Feb 10, 2025 •
edited
Loading

With most efforts redirected towards encoding/json v2. I don't think
refactoring/cleaning changes in #43126 will ever be addressed in v1.

I don't think we should consider it as a requirement for this patch.

This could have been added as part of 2596a0c

encoding/json v2 is moving in the same direction by adding context by
default as shown in https://github.com/go-json-experiment/json/blob/4e0381018ad68adc9c0cb7896d109c994429654e/errors.go#L364-L373

But we don't need to wait for v2 to become stable to improve UX
and save users some time, and help them keep their hair!

Fixes #58649

This PR will be imported into Gerrit with the title and first
comment (this text) used to generate the subject and body of
the Gerrit change.

Please ensure you adhere to every item in this list.

More info can be found at https://github.com/golang/go/wiki/CommitMessage

  • The PR title is formatted as follows: net/http: frob the quux before blarfing
    • The package name goes before the colon
    • The part after the colon uses the verb tense + phrase that completes the blank in,
      "This change modifies Go to ___________"
    • Lowercase verb after the colon
    • No trailing period
    • Keep the title as short as possible. ideally under 76 characters or shorter
  • No Markdown
  • The first PR comment (this one) is wrapped at 76 characters, unless it's
    really needed (ASCII art, table, or long link)
  • If there is a corresponding issue, add either Fixes #1234 or Updates #1234
    (the latter if this is not a complete fix) to this comment
  • If referring to a repo other than golang/go you can use the
    owner/repo#issue_number syntax: Fixes golang/tools#1234
  • We do not use Signed-off-by lines in Go. Please don't add them.
    Our Gerrit server & GitHub bots enforce CLA compliance instead.
  • Delete these instructions once you have read and applied them

@machine424
encoding/json: add context during decoding when disallowUnknownFields…
1dcfad0 
… is set

Fixes golang#58649
without relying on the mentioned refactoring/cleaning in
golang#43126

With most efforts redirected towards encoding/json v2.
I don't think golang#43126 will ever be addressed in v1.

I don't think we should consider it as a requirement for this patch.

This could have been added as part of golang@2596a0c

encoding/json v2 is moving in the same direction by adding context by default
as shown in https://github.com/go-json-experiment/json/blob/4e0381018ad68adc9c0cb7896d109c994429654e/errors.go#L364-L373

But we don't need to wait for v2 to become stable to improve UX and
and save users some time, and help them keep their hair!
@google-cla Google CLA
Copy link

google-cla bot commented Feb 10, 2025

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@machine424 machine424 mentioned this pull request Feb 10, 2025
Open
@gopherbot
Copy link
Contributor

This PR (HEAD: 1dcfad0) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/648055.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/648055.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Gopher Robot:

Patch Set 1:

Congratulations on opening your first change. Thank you for your contribution!

Next steps:
A maintainer will review your change and provide feedback. See
https://go.dev/doc/contribute#review for more info and tips to get your
patch through code review.

Most changes in the Go project go through a few rounds of revision. This can be
surprising to people new to the project. The careful, iterative review process
is our way of helping mentor contributors and ensuring that their contributions
have a lasting impact.

During May-July and Nov-Jan the Go project is in a code freeze, during which
little code gets reviewed or merged. If a reviewer responds with a comment like
R=go1.11 or adds a tag like "wait-release", it means that this CL will be
reviewed as part of the next development cycle. See https://go.dev/s/release
for more details.

Please don’t reply on this GitHub thread. Visit golang.org/cl/648055.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

This PR (HEAD: 5c43046) has been imported to Gerrit for code review.

Please visit Gerrit at https://go-review.googlesource.com/c/go/+/648055.

Important tips:

  • Don't comment on this PR. All discussion takes place in Gerrit.
  • You need a Gmail or other Google account to log in to Gerrit.
  • To change your code in response to feedback:
    • Push a new commit to the branch used by your GitHub PR.
    • A new "patch set" will then appear in Gerrit.
    • Respond to each comment by marking as Done in Gerrit if implemented as suggested. You can alternatively write a reply.
    • Critical: you must click the blue Reply button near the top to publish your Gerrit responses.
    • Multiple commits in the PR will be squashed by GerritBot.
  • The title and description of the GitHub PR are used to construct the final commit message.
    • Edit these as needed via the GitHub web interface (not via Gerrit or git).
    • You should word wrap the PR description at ~76 characters unless you need longer lines (e.g., for tables or URLs).
  • See the Sending a change via GitHub and Reviews sections of the Contribution Guide as well as the FAQ for details.

@gopherbot
Copy link
Contributor

Message from Joseph Tsai:

Patch Set 2:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/648055.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from ayoub mrini:

Patch Set 2:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/648055.
After addressing review feedback, remember to publish your drafts!

@machine424 machine424 changed the title encoding/json: add context during decoding when disallowUnknownFields s set encoding/json: add context during decoding when disallowUnknownFields is set Feb 11, 2025
@gopherbot
Copy link
Contributor

Message from ayoub mrini:

Patch Set 2:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/648055.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from ayoub mrini:

Patch Set 3:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/648055.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Joseph Tsai:

Patch Set 3:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/648055.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from ayoub mrini:

Patch Set 3:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/648055.
After addressing review feedback, remember to publish your drafts!

@gopherbot
Copy link
Contributor

Message from Joseph Tsai:

Patch Set 3:

(1 comment)

Please don’t reply on this GitHub thread. Visit golang.org/cl/648055.
After addressing review feedback, remember to publish your drafts!

@machine424
Copy link
Author

encoding/json is frozen for such changes.
See discussion here https://go-review.googlesource.com/c/go/+/648055#message-c41900eb8f058832f1e30fa679a6c8a35dd50159

@machine424 machine424 closed this Feb 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

encoding/json: show nested fields path if DisallowUnknownFields leads to an error
2 participants
@machine424 @gopherbot