More explicit error on empty JSON bodies #459
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Return a more understandable error when the JSON codec attempts to unmarshal an empty body. Fixes #452.
mattrobenolt
reviewed
Feb 9, 2023
codec.go
Outdated
| @@ -93,6 +94,9 @@ func (c *protoJSONCodec) Unmarshal(binary []byte, message any) error { | |||
| if !ok { | |||
| return errNotProto(message) | |||
| } | |||
| if len(binary) == 0 { | |||
| return errors.New("empty string is not a valid JSON object") | |||
There was a problem hiding this comment.
Can we elevate this up to a package level var ErrEmptyBody or something to make it easier for a user to check like, err == connect.ErrEmptyBody
There was a problem hiding this comment.
I think this error is still mostly for manual inspection;
it's useful in testing and manual verification if something goes wrong but I don't think clients should ever be sending invalid json and then building error handling around this error because they should check that empty strings aren't sent in the first place
There was a problem hiding this comment.
Tend to agree with Josh; I'd like to see a little more evidence that people need programmatic comparison to this error - e.g., they're writing interceptors that handle this case and retry the inner function with a zero-value request message.
Public API is forever, so I'd rather be conservative in adding it.
joshcarp
approved these changes
Feb 10, 2023
renovate bot
referenced
this pull request
in open-feature/flagd
Feb 16, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/bufbuild/connect-go](https://togithub.com/bufbuild/connect-go) | require | patch | `v1.5.1` -> `v1.5.2` | --- ### Release Notes <details> <summary>bufbuild/connect-go</summary> ### [`v1.5.2`](https://togithub.com/bufbuild/connect-go/releases/tag/v1.5.2) [Compare Source](https://togithub.com/bufbuild/connect-go/compare/v1.5.1...v1.5.2) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Bugfixes - More explicit error on empty JSON bodies by [@​akshayjshah](https://togithub.com/akshayjshah) in [https://github.com/bufbuild/connect-go/pull/459](https://togithub.com/bufbuild/connect-go/pull/459) - Fix string casing for gRPC-Web trailers by [@​timostamm](https://togithub.com/timostamm) in [https://github.com/bufbuild/connect-go/pull/461](https://togithub.com/bufbuild/connect-go/pull/461) **Full Changelog**: bufbuild/connect-go@v1.5.1...v1.5.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/open-feature/flagd). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMzguMyIsInVwZGF0ZWRJblZlciI6IjM0LjEzOC4zIn0=--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
akshayjshah
added a commit
that referenced
this pull request
Jul 26, 2023
Return a more understandable error when the JSON codec attempts to unmarshal an empty body. Fixes #452.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Return a more understandable error when the JSON codec attempts to
unmarshal an empty body.
Fixes #452.