Handle non-JSON API responses gracefully#729
Open
Sim-hu wants to merge 1 commit into
Open
Conversation
Replace Jason.decode! with Jason.decode in API response handling so that non-JSON responses (e.g. HTML error pages from Cloudflare when Discord is down) produce clear errors instead of confusing Jason.DecodeError crashes. Closes Kraigie#417
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Replace
Jason.decode!withJason.decodein API response handling, so that non-JSON responses produce clear errors instead of crashing with a confusingJason.DecodeError.Motivation
When Discord is down or a proxy returns an HTML error page (e.g. 502 Bad Gateway), the ratelimiter may forward a non-JSON body that causes
Jason.decode!to crash with a misleading error like:This makes it look like a protocol-level bug when the actual issue is just that Discord is down. As discussed in #417, using
Jason.decode(non-bang) and handling the error case provides a much clearer signal.Changes
lib/nostrum/api/helpers.ex—handle_request_with_decode/1andhandle_request_with_decode/2now useJason.decodeand return{:error, %ApiError{}}on decode failurelib/nostrum/util.ex—get_new_gateway_url/0now usesJason.decodeand raises a descriptive message on failureTesting
mix compile --warnings-as-errorspassesmix test— 212 tests, 0 failuresCloses #417