Allow a consumer to switch between JSON and binary encoding for awareness #27
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
…xported encoding and decoding methods, and add a binary encoding strategy.
…xported encoding and decoding methods, and add a binary encoding strategy.
|
Thank you, looks great! |
dmonad
reviewed
Mar 31, 2023
| * @param {encoding.Encoder} encoder | ||
| * @param {any} update | ||
| */ | ||
| encodeState (encoder, update) { |
There was a problem hiding this comment.
These should be static methods. Then there is no need to create an instance of *AwarenessStateEncoder
| * @return {Uint8Array} | ||
| */ | ||
| export const encodeAwarenessUpdate = (awareness, clients, states = awareness.states) => { | ||
| export const encodeAwarenessUpdate = (awareness, clients, states = awareness.states, stateEncoder = new DefaultAwarenessStateEncoder()) => { |
There was a problem hiding this comment.
It should not be necessary to create a new instance of anything here. *AwarenessEncoder should only have static methods.
| @@ -51,3 +52,7 @@ export const testAwareness = tc => { | |||
| t.compare(aw1.getStates().get(0), undefined) | |||
| t.compare(lastChangeLocal, lastChange) | |||
| } | |||
|
|
|||
| export const testAwareness = testAwarenessWithEncoding() | |||
There was a problem hiding this comment.
This test is the same as the third test and can be removed.
There was a problem hiding this comment.
I'll augment this test a bit, I'd like to add a test to ensure the default behaviour is using the default encoder.
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.
This PR is intended to add support for binary awareness encoding as discussed in #26. I'd appreciate any feedback you have!
I have tested it out locally for my use case - and it appears to be working correctly in both modes.