fix(streaming): skip control-only SSE blocks with no data - #3839
Closed
lazerg wants to merge 1 commit into
Closed
Conversation
Author
|
Closing since the linked issue was closed. Happy to reopen if it turns out the fix is still wanted. |
This file contains hidden or 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
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.
Changes being requested
An SSE block carrying only
retry:orid:has no data, but the blank-line guard inSSEDecoder.decode()also looked at_last_event_idand_retry, so it dispatched an event with empty data anyway.Stream.__stream__()runs every event throughsse.json(), and that empty event ends an otherwise valid stream with a JSON decoding error before the next data event is read._last_event_idis kept across events on purpose, so once a stream has sent anid:field, any later blank line hits the same path.The guard now dispatches only when an event name or data is buffered. Both fields stay on the decoder, so the next real event still reports the current id and retry.
Additional context & links
Closes #3833
tests/test_streaming.py::test_control_only_blocks_are_skippedfails on main and passes with this change. The streaming and SSE framing suites pass, and ruff check and format are clean on both touched files.