GSON upgrade and illegal reflective fix #54
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
This upgrades the gson dependency to the most current version.
The error thrown has changed since GSON now checks for a BEGIN_OBJECT
`{`. Since there is none to be found this more specific syntax exception is
thrown instead of a parse exception.
Without this custom serializer for java.lang.Throwable our calls to gson.toJson were raising this warning: ``` WARNING: Illegal reflective access by com.google.gson.internal.reflect.UnsafeReflectionAccessor (file:/home/runner/.gradle/caches/modules-2/files-2.1/com.google.code.gson/gson/2.8.6/9180733b7df8542621dc12e21e87557e8c99b8cb/gson-2.8.6.jar) to field java.lang.Throwable.detailMessage WARNING: Please consider reporting this to the maintainers of com.google.gson.internal.reflect.UnsafeReflectionAccessor WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations WARNING: All illegal access operations will be denied in a future release ``` As viewable in the previous commit's specs: https://github.com/airbrake/javabrake/runs/2405994493#step:4:156
Trying to serialize a java.lang.Throwable will raise a warning about illegal reflection. Marking the Throwable being serialized as `transient` will cause gson to ignore this field during serialization, it's not part of the notice payload anyway. https://github.com/google/gson/blob/master/UserGuide.md#java-modifier-exclusion Note on transient keyword: > `transient` is a Java keyword which marks a member variable not to be serialized when it is persisted to streams of bytes. When an object is transferred through the network, the object needs to be 'serialized'. source: [wikibooks - Java Programming](https://en.wikibooks.org/wiki/Java_Programming/Keywords/transient)
|
Thanks for the review @kyrylo! |
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.
In this PR we upgrades the GSON dependency to the most current version and mark the
Notice'sThrowable exceptionfield astransientto avoid GSON serialization. Theexceptionfield isn't used in the notice payload sent to Airbrake and we already extract the type, message, and backtrace from it.This was the error that was reported and seen in our ci specs previous to this fix commit. we no longer see the illegal reflection warning in the latest ci runs of the tests.
Marking the Throwable being serialized as
transientwill cause gson to ignore this field during serialization https://github.com/google/gson/blob/master/UserGuide.md#java-modifier-exclusionBased on what I read about
transient, it makes sense that GSON ignores the field:closes #34