protocol: frame messages with length-prefix instead of newlines #51
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
lhchavez
approved these changes
Feb 6, 2024
| const spy = vi.fn(); | ||
| parser.on('data', spy); | ||
|
|
||
| const emojiMessage = '🇧🇪🇨🇦👨👩👧👦'; |
There was a problem hiding this comment.
the notorious 🇩🇪 returns
| }); | ||
| } | ||
|
|
||
| export const MessageFramer = { |
There was a problem hiding this comment.
is it worth having a no-op framer for when we write these things to a websocket transport (or something that already has framing built-in? like a SEQPACKET UDS)
There was a problem hiding this comment.
ah nevermind, i saw that those cases don't even use one. carry on.
Co-authored-by: lhchavez <lhchavez@lhchavez.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.
Why
We want to have newlines in our messages :) The old approach failed when we used the binary codec with a string or Uint8Array that contained a newline in it. This is because we framed our messages with newlines so we would get cases where a single message would be split in two.
What changed
Use
uint32-prefix framing instead.