Repository navigation
Decode server-sent events as UTF-8 with BOM handling - #1308
Open
theamodhshetty wants to merge 1 commit into
Open
theamodhshetty wants to merge 1 commit into
theamodhshetty wants to merge 1 commit into
Conversation
Merging this PR will not alter performance
Comparing Footnotes
|
This branch has not been deployed
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.
Summary
A leading UTF-8 BOM currently hides the first
data,event, oridfield in an SSE response. It can also trigger a false event-size error. A non-UTF-8 response charset or client default encoding corrupts UTF-8 event data.The SSE parsing rules require UTF-8 decoding and ignoring exactly one leading BOM. Decode response content bytes through the existing incremental
TextDecoderbefore line buffering and size checks. Later U+FEFF characters remain intact, andResponse.encodingis unchanged.Added 42 parameterized sync/async regression cases covering fragmented BOMs and UTF-8 characters, event metadata, exact size limits, later/double BOMs, and charset/default-encoding overrides. Updated the SSE documentation.
Local validation on Python 3.15.0:
b77e3e8, nine sync regressions fail and five controls pass.scripts/coveragereports 100% coverage;scripts/checkpasses formatting, typing, lint, lockfile and unasync checks.Hosted CI and maintainer review remain separate gates.
Checklist
Implementation and tests were prepared with Codex assistance.