Ensure correct Faraday JSON parsing/response body for invalid response header #110
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
|
Perfect! can you fix rubocop problem and add a CHANGELOG entry per this and we are |
…e header See my investigation here: #100 (comment) In the Faraday 1 to Faraday 2 process, the ensure JSON response middleware was rewritten from scratch, which caused a change in how permissive the middleware was to response Content-Type headers which did not properly indicate a JSON response. In Faraday 1.x, the JSON middleware would attempt a JSON parse of the body, regardless of the presence or value of a Content-Type header. This meant that Graphlient would have raised an exception (or re-raised one caught from Faraday) if the response body was not valid JSON. In Faraday 2.x, the new JSON middleware will only attempt to parse the response body if it determines that the Content-Type response header indicates a JSON body. By default it uses a regex on the header value (/\bjson$/ at the time of writing). Crucially, if the header is missing, or does not match the regex, instead of raising an exception, `Faraday::Response#body` returns a String, rather than the previously-assumed Hash or Array. This change restores the parsing logic which is tolerant to incorrect or missing Content-Type header values. Response bodies which are not valid JSON will raise an exception. Any unforseen situation where `#body` returns a type that is not String, Hash, or Array, will raise a separate exception detailing that this is unexpected behavior and a bug should be filed. Resolves #100
|
@ashkan18 Done 👍 |
|
@taylorthurlow just created a new version |
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.
See my investigation here:
#100 (comment)
In the Faraday 1 to Faraday 2 process, the JSON response middleware was rewritten from scratch, which caused a change in how permissive the middleware was to response Content-Type headers which did not properly indicate a JSON response.
In Faraday 1.x, the JSON middleware would attempt a JSON parse of the body, regardless of the presence or value of a Content-Type header. This meant that Graphlient would have raised an exception (or re-raised one caught from Faraday) if the response body was not valid JSON.
In Faraday 2.x, the new JSON middleware will only attempt to parse the response body if it determines that the Content-Type response header indicates a JSON body. By default it uses a regex on the header value (
/\bjson$/at the time of writing). Crucially, if the header is missing, or does not match the regex, instead of raising an exception,Faraday::Response#bodyreturns a String, rather than the previously-assumed Hash or Array.This change restores the parsing logic which is tolerant to incorrect or missing Content-Type header values. Response bodies which are not valid JSON will raise an exception. Any unforeseen situation where
#bodyreturns a type that is not String, Hash, or Array, will raise a separate exception detailing that this is unexpected behavior and a bug should be filed.Resolves #100
I can't say that I have actually replicated any graphlient-on-Faraday-1.x functionality here, as far as what exceptions are raised on failed JSON parsing, but at the very least, the production application I am using this library in is now functioning as it did before the transition.
I also added new specs.