Improve handling of non-JSON errors. #166
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
When getting a non-200 HTTP response, orderly tries to decode the body as JSON in order to extract the error message. We do however occasionally get errors that aren't JSON formatted, in particular if the error is generated by nginx rather than Packit. This situation can arise if the Packit server is down (a 503 error), or if nginx rejects the request due to the body being too large (a 413 error). We can use the content type header of the response to determine whether it is safe to decode the body as JSON. If the response is not of the expected mime-type, the body is ignored and a generic error based on the status code alone is returned.
richfitz
approved these changes
Aug 23, 2024
Co-authored-by: Rich FitzJohn <[email protected]>
plietar
force-pushed
the
mrc-5706-error-no-json
branch
from
3876501 to
47e81c2
Compare
plietar
added a commit
that referenced
this pull request
Sep 5, 2024
In some circumstances, Packit returns an HTTP error with no body and no Content-Type header. In those cases, httr2 returns NA as the content type. #166 added a check to make sure the content type is JSON before decoding the error, however the check did not handle NA values properly and gave a `missing value where TRUE/FALSE needed`. This now uses `identical` instead of `==` to compare the content type string against the expected string.
plietar
added a commit
that referenced
this pull request
Sep 5, 2024
In some circumstances, Packit returns an HTTP error with no body and no Content-Type header. In those cases, httr2 returns NA as the content type. #166 added a check to make sure the content type is JSON before decoding the error, however the check did not handle NA values properly and gave a `missing value where TRUE/FALSE needed`. This now uses `identical` instead of `==` to compare the content type string against the expected string.
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.
When getting a non-200 HTTP response, orderly tries to decode the body as JSON in order to extract the error message. We do however occasionally get errors that aren't JSON formatted, in particular if the error is generated by nginx rather than Packit.
This situation can arise if the Packit server is down (a 503 error), or if nginx rejects the request due to the body being too large (a 413 error).
We can use the content type header of the response to determine whether it is safe to decode the body as JSON. If the response is not of the expected mime-type, the body is ignored and a generic error based on the status code alone is returned.