fix(sdk): decode SSE error body before formatting in stream client#4345
Open
CAN-Aidoo wants to merge 1 commit into
Open
fix(sdk): decode SSE error body before formatting in stream client#4345CAN-Aidoo wants to merge 1 commit into
CAN-Aidoo wants to merge 1 commit into
Conversation
SSEClient._handle_sse_response formatted the raw bytes body straight into the error message, rendering it as b'...' with escaped byte sequences and requiring a type: ignore[str-bytes-safe] and noqa: E501 to suppress the warning (the existing TODO in the file called this out). Decode with errors="replace" so non-UTF-8 responses still surface a readable message, and drop the ignore comments.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe SSE error-handling path in ChangesSSE Error Body Decoding
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
Decode the bytes body in
SSEClient._handle_sse_responsebefore interpolating it into the error message, using.decode(errors=\"replace\")to stay safe on non-UTF-8 responses. Drops the acknowledging# TODO, the# type: ignore[str-bytes-safe], and the# noqa: E501.Motivation
response.aread()returnsbytes, so the previous f-string rendered the body asb'{\"error\":...}'— leadingb, surrounding quotes, and\xNNescapes for any non-ASCII byte. The success path two lines below already doesresponse_text.decode(); this PR reuses that pattern for the error path. The existing# TODO: Fix bytes formatting - should decode error_text or use !rin the file called this out.Test plan
tests/evaluator/test_stream_client.pycovers the happy path (readable decoded body in the raised exception, nob'artifact) and non-UTF-8 input (does not raise on decode).uv run ruff checkpasses on the modified files.Summary by CodeRabbit
Bug Fixes
Tests