fix(streaming): preserve first SSE event after BOM - #3819
Open
Hughhhhcoder wants to merge 1 commit into
Open
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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.
Changes being requested
Strip the single leading UTF-8 byte-order mark allowed by the SSE format before interpreting the first line.
Today
SSEDecoderdecodes each completed line independently. A valid stream beginning with a BOM therefore presents its first field as\ufeffdatainstead ofdata, so the decoder silently drops the first event. The WHATWG event-stream interpretation algorithm explicitly strips one leading UTF-8 BOM.The decoder now tracks the first line of each stream and removes only a leading BOM there. The regression covers synchronous and asynchronous decoding with the three BOM bytes both contiguous and split across input chunks.
Additional context & links
BOM + data:first + blank line + data:secondyielded onlysecondfirst, thensecondValidation:
uv run --locked --all-extras pytest tests/test_sse_framing.py— 48 passed./scripts/test-pydantic-v1 tests/test_sse_framing.py— 48 passed./scripts/lint— Ruff, Pyright, Mypy, and import checks passedgit diff --check origin/main...HEAD— passed