Skip empty SSE control events - #3836
Closed
seanxuu wants to merge 1 commit into
Closed
Conversation
Ignore empty-data SSE control records before JSON decoding so streams can continue to the next valid event. Add synchronous and asynchronous regression coverage. Fixes openai#3833 Signed-off-by: Sean <seanxu@connect.hku.hk>
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
1 participant
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.
Fixes #3833
Changes being requested
Ignore SSE records that contain control metadata but no data before attempting JSON decoding. This keeps
StreamandAsyncStreammoving to the next valid event while leaving the decoder metadata behavior unchanged.Additional context & links
The regression test covers both synchronous and asynchronous streams with
id/retrycontrol fields followed by a valid JSON event.Validation
uvx --from uv==0.12.1 uv run --locked pytest tests/test_streaming.py -q(22 passed)uvx --from uv==0.12.1 uv run --locked ruff check src/openai/_streaming.py tests/test_streaming.pyuvx --from uv==0.12.1 uv run --locked ruff format --check src/openai/_streaming.py tests/test_streaming.py