Update Serializer object to be an interface #219
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
bugsnag/src/main/java/com/bugsnag/serialization/ISerializer.java
Outdated
Show resolved
Hide resolved
bugsnag/src/main/java/com/bugsnag/serialization/ISerializer.java
Outdated
Show resolved
Hide resolved
| @@ -95,6 +103,27 @@ public void testInvalidSessionEndpoint() { | |||
| assertEquals("http://sessions.example.com", getDeliveryEndpoint(config.sessionDelivery)); | |||
| } | |||
|
|
|||
| @Test | |||
| public void testSerializeObject() throws SerializationException { | |||
There was a problem hiding this comment.
This doesn't feel like the right level of test - the unit tests are testing that configuration is set right, rather than that what is provided does the right thing. So you could pass your own implementation of Serializer in that simply writes "foo" to the output stream and then validate that this is what you receive back; but we shouldn't compare JSON outputs.
CHANGELOG.md
Outdated
| @@ -8,6 +8,8 @@ | |||
|
|
|||
| * Add a null check for `Severity` to the notify override method. [#214](https://github.com/bugsnag/bugsnag-java/pull/214) | |||
|
|
|||
| * Add handling for non serializable object passed to metadata. [#219](https://github.com/bugsnag/bugsnag-java/pull/219) | |||
There was a problem hiding this comment.
This and the PR description need updating for the amended approach - we're not handling non-serializable objects directly: just providing a way for people to do so if they provide their own serializer.
There was a problem hiding this comment.
The PR title and description are still out of date
bugsnag/src/main/java/com/bugsnag/serialization/Serializer.java
Outdated
Show resolved
Hide resolved
clr182
changed the title
Co-authored-by: Tom Longridge <tom@bugsnag.com>
tomlongridge
approved these changes
Aug 27, 2024
Merged
clr182
added a commit
that referenced
this pull request
Aug 29, 2024
* (docs): update docs references from `master` to `main` * (docs): switch build status badge to buildkite * Update selector to accept only the major version * Update Changelog * update linting * Added severity check (#214) * added severity check * fixed linting * fixed linting v2 * added changelog entry * Reverting changes * update notify override with null check * Update changelog * Update Bugsnag.java call notify override method on null severity * add aopproxyutils dependancy and add handling in scheduledTaskConfig class (#218) * add aopproxyutils dependancy and add handling in scheduledTaskConfig class * fixed comment typo * fixed import of aoputils * added proxy testing * fixed linting * Updated tests * updated tests * update changelog * moving createProxy method to util class * update variable name * reverting * Update Serializer object to be an interface (#219) * Adding non serializable metadata handling * removed an unused import * update feature * update changelog * Add serializeObject public method * Fixed linting * fixed tests * Implemented Serializer interface * update scenarios * update changelog * Changes based on feedback * update tests * updates based on reviews * Update bugsnag/src/main/java/com/bugsnag/Configuration.java Co-authored-by: Tom Longridge <tom@bugsnag.com> * update config --------- Co-authored-by: Tom Longridge <tom@bugsnag.com> * v3.7.2 --------- Co-authored-by: Yousif Ahmed <yousif@bugsnag.com> Co-authored-by: Yousif <74918474+yousif-bugsnag@users.noreply.github.com> Co-authored-by: Tom Longridge <tom@bugsnag.com>
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.
Goal
Sometimes a non-serializable object can be passed as metadata, which can cause an error. As such the Serializer class should be converted to an interface so a user may use their own serializer which inherits from the Serializer interface.
Design
To allow users to develop their own Serializer for handling non-serializable data.
Changeset
Created an ISerializer class and changed the Serializer class to implement it.
By default this creates a default serializer if it is not specified in the configuration option.
Testing
Added test
testCustomSerializertoConfigurationTest.javawhich creates an anonymous class extending theDefaultSerializerand overwrites theWriteToStreammethod to writefoo. Added anassertTruecall if the method has been called and added a call toassertEqualto confirm that the expected value is the same as the output.