Improve exception messages from HttpObjectDecoder
#1228
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
Scottmitch
reviewed
Nov 20, 2020
servicetalk-http-api/src/main/java/io/servicetalk/http/api/HeaderUtils.java
Outdated
Show resolved
Hide resolved
servicetalk-http-netty/src/main/java/io/servicetalk/http/netty/HttpObjectDecoder.java
Outdated
Show resolved
Hide resolved
...lk-utils-internal/src/main/java/io/servicetalk/utils/internal/IllegalCharacterException.java
Outdated
Show resolved
Hide resolved
servicetalk-http-netty/src/main/java/io/servicetalk/http/netty/HttpObjectDecoder.java
Outdated
Show resolved
Hide resolved
servicetalk-http-netty/src/main/java/io/servicetalk/http/netty/HttpResponseDecoder.java
Show resolved
Hide resolved
servicetalk-http-netty/src/main/java/io/servicetalk/http/netty/HttpResponseDecoder.java
Outdated
Show resolved
Hide resolved
Motivation: `HttpObjectDecoder` and its subclasses may throw an exception if the received HTTP message violates the RFC and can not be parsed. However, exception messages are short and hard to understand, without any pointers to what part of the message caused an exception. Those cases are hard to debug and usually require knowledge of RFC. Modifications: - Introduce `IllegalCharacterException` type that shows an illegal character as a `char` and in hex format, as well as an expected values; - `try-catch` an `IllegalCharacterException` and wrap it with `DecoderException` that clarifies where the illegal character was found; - Adjust tests for new exception messages; Result: More understandable exception messages from `HttpObjectDecoder`.
idelpivnitskiy
force-pushed
the
decoder-exceptions
branch
from
3463b23 to
879e3b6
Compare
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.
Motivation:
HttpObjectDecoderand its subclasses may throw an exception if the receivedHTTP message violates the RFC and can not be parsed. However, exception messages
are short and hard to understand, without any pointers to what part of the
message caused an exception. Those cases are hard to debug and usually require
knowledge of RFC.
Modifications:
IllegalCharacterExceptiontype that shows an illegal character asa
charand in hex format, as well as expected values;try-catchanIllegalCharacterExceptionand wrap it withDecoderExceptionthat clarifies where the illegal character was found;
Result:
More understandable exception messages from
HttpObjectDecoder.Depends on #1227.