Avoid Instant and LocalDate GSON serialization errors (Java 17+) #48
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 serializing an email, serialize the Java type LocalDate using a custom GSON TypeAdapter: LocalDateTypeAdapter. LocalDateTypeAdapter just serializes LocalDate values calling LocalDate's toString method.
When serializing an email, serialize the Java type Instant using a custom GSON TypeAdapter: InstantTypeAdapter. InstantTypeAdapter just serializes Instant values calling Instant's toString method.
johnkelesidis
approved these changes
Jan 19, 2024
|
thanks for this pr, merging |
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.
Mailersend uses the default GSON serializer for serializing some classes when using then
com.mailersend.sdk.emails.Email.serializeForSendingmethod. The default GSON serializer uses reflection to serialize such classes; this is not compatible with a change made in the JDK for Java 17 (see JEP 403 or https://github.com/google/gson/blob/main/Troubleshooting.md#-inaccessibleobjectexception-module--does-not-opens--to-unnamed-module) regarding reflection, causing acom.google.gson.JsonIOExceptionto be thrown when calling thecom.mailersend.sdk.emails.Email.serializeForSendingmethod.For the Mailersend client, this problem usually happens when you pass an Object that contains fields of type
java.time.LocalDateorjava.time.Instantto thecom.mailersend.sdk.emails.Email.addPersonalizationmethod and then send the email using thecom.mailersend.sdk.emails.Emails.sendmethod.GSON's suggested solution says:
As the second option would imply changing the
com.mailersend.sdk.emails.Email.addPersonalizationmethod or restricting the classes that can be serialized, I have implemented the first solution by adding TypeAdapters for thejava.time.LocalDateandjava.time.Instantclasses.