golang / go

The Go programming language
https://go.dev
BSD 3-Clause "New" or "Revised" License
124.22k stars 17.7k forks source link

encoding/json: return JSON field with all unmarshal errors #70386

Open thequailman opened 6 days ago

thequailman commented 6 days ago

Fixes #22816

JSON unmarshal can return an error type, UnmarshalTypeError, that contains very useful information such as the field that an error originated from. Unfortunately, this error type is not always returned and that information is not bubbled up during unmarshaling. This makes it difficult to return helpful API or CLI responses to users so they can correct invalid JSON.

This PR changes unmarshal to always wrap errors using this type. The behavior stays mostly the same:

This PR has the possibility of breaking error comparisons if folks are doing something like this:

if err := json.Unmarshal(b, &v); err == UnmarshalSentinelError

As the err type will no longer be returned as the Unmarshal error but wrapped using UnmarshalTypeError. To work around this, users can do:

if err := json.Unmarshal(b, &v); errors.Is(err, UnmarshalSentinelError)

If this is too much of a breaking change, I would like to rework the PR into a new function that performs this new error behavior. Feedback welcome on what to call it, UnmarshalWithErr seems a bit wordy.

gopherbot commented 6 days ago

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

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

Important tips:

gopherbot commented 6 days ago

Message from Gopher Robot:

Patch Set 1:

(1 comment)


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

gopherbot commented 6 days ago

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/628556. After addressing review feedback, remember to publish your drafts!

gopherbot commented 6 days ago

Message from Ian Lance Taylor:

Patch Set 1: Commit-Queue+1

(5 comments)


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

gopherbot commented 6 days ago

Message from Go LUCI:

Patch Set 1:

Dry run: CV is trying the patch.

Bot data: {"action":"start","triggered_at":"2024-11-16T02:48:13Z","revision":"bff226e187023e928325cde4af1bceb0367a6ee9"}


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

gopherbot commented 6 days ago

Message from Ian Lance Taylor:

Patch Set 1: -Commit-Queue


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

gopherbot commented 6 days ago

Message from Go LUCI:

Patch Set 1:

This CL has failed the run. Reason:

Tryjob golang/try/gotip-linux-amd64-aliastypeparams has failed with summary (view all results):


Build or test failure, click here for results.

To reproduce, try gomote repro 8731148130349092481.

Additional links for debugging:


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

gopherbot commented 6 days ago

Message from Go LUCI:

Patch Set 1: LUCI-TryBot-Result-1


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

gopherbot commented 6 days ago

Message from Ian Lance Taylor:

Patch Set 1: Hold+1

(1 comment)


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