Handle multi-line data while composing SSE #250
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
atesgoral
commented
Oct 6, 2023
|
|
||
| let { value: event } = await reader.read(); | ||
| expect(event).toEqual(new TextEncoder().encode("event: message\n")); | ||
| expect(decoder.decode(event)).toEqual("event: message\n"); |
There was a problem hiding this comment.
Using a decoder on the actual value instead of using an encoder on the expected value gives human-readable diffs of strings. It's very hard to understand what's wrong by looking at the Int8 array diff.
|
@sergiodxa bump |
|
I'd also be interested in getting this merged, @sergiodxa anything we can do to help? |
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.
Data with new line characters should be emitted as adjacent
datafields.Instead of:
data: hello\nworld\n\nwhich goes through the wire as:
It should be:
data: hello\ndata: world\n\nwhich goes through the wire as:
Without proper handling of new line characters, people using this library in the wild are forced to encode their data as JSON or Base-64 (and back after reading events from an SSE client).
Demonstration of the issue this PR is fixing (using a spec-compliant parser instead of focusing on individual chunks):
https://runkit.com/atesgoral/multi-line-sse-data
Spec:
https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation