Preserve IOException cause in JWTParser decode errors#781
Open
asim-alam wants to merge 1 commit into
Open
Conversation
JWTParser was wrapping malformed JSON errors in a JWTDecodeException without keeping the original IOException as the cause. This change passes the original IOException through so callers can inspect the root cause. It also adds a regression test for malformed JSON parsing.
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
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.
Changes
JWTParser.parsePayloadandJWTParser.parseHeadercatch the JacksonIOExceptionthrown while parsing a token's JSON, but rethrow it as a
JWTDecodeExceptionwithoutpassing the original exception as the cause. As a result, Jackson's parsing details,
including the message and source location, are lost from the exception chain.
This PR forwards the caught
IOExceptionas the cause:decodeException(String json, Throwable cause)overload inJWTParserthat builds the same message and passes the cause through.
catch (IOException e)sites inparsePayloadandparseHeaderto use it.JWTDecodeExceptionalready has a(String, Throwable)constructor.only
getCause()on the parse-failure path changes fromnullto the underlying Jackson exception.Before:
After:
References
Found via static analysis: PMD's
PreserveStackTracerule flags both catch sites.No related support ticket or community post.
Testing
Added
JWTParserTest.shouldPreserveCauseWhenParsingInvalidJson, which asserts the thrownJWTDecodeException's cause is the underlyingIOException.Ran the full module suite with
./gradlew :java-jwt:test: 680 tests, 0 failuresThis change adds unit test coverage
This change has been tested on the latest version of the platform/language
Checklist