Use inspect/1 to safely encode bad binary samples #1121
Merged
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.
My team finds ourselves in an odd situation.
0xDF
)The parser correctly fails when it encounters the bad byte, but it also generates an error message with a sample of the input that could not be parsed as a string.
In this case the string it generates is not a valid string because it includes the bad byte. This can cause problems later, for example when
absinthe_plug
attempts to JSON encode the phase error and send it to the client. In that case the end result is an exception and a 500.Given the typespec of
Absinthe.Phase.Error.message
isString.t()
I think it's safe to say Absinthe itself should ensure that's the case. The simplest option to me seems to simply run the "sample" we take throughinspect/1
.We still preserve useful debugging information by sending back the list of bytes which I consider a good thing personally.
I don't have a strong opinion on the style of the code below, happy to modify it however we see fit. I did opt to only apply this if the string isn't valid so we don't change the way existing errors are formatted.