Add support for a binary serializer #72
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
In some cases, when using Phoenix channels, it is possible to use a
binary serializer. The library already has support for binary messages,
but this is slightly different. With a binary serializer, all messages
can be sent in a binary format, not just individual payloads. This
commit changes the contract for the serializer to allow returning a
binary as before, or the tuple `{:binary, binary}`
In the integration tests, an example binary encoder that uses
`term_to_binary/1` and `binary_to_term/1` is used. The integration tests
are run both against the existing text based serializer, and the
reference binary serializer. The `GoodExample` has been modified to take
a set of options instead of reading them from the config, although a
fallback is used to minimize the number of tests updated.
for consistency with the other similar calls
the-mikedavis
approved these changes
Feb 4, 2025
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 some cases, when using Phoenix channels, it is possible to use a binary serializer. The library already has support for binary messages, but this is slightly different. With a binary serializer, all messages can be sent in a binary format, not just individual payloads. This commit changes the contract for the serializer to allow returning a binary as before, or the tuple
{:binary, binary}In the integration tests, an example binary encoder that uses
term_to_binary/1andbinary_to_term/1is used. The integration tests are run both against the existing text based serializer, and the reference binary serializer. TheGoodExamplehas been modified to take a set of options instead of reading them from the config, although a fallback is used to minimize the number of tests updated.