Fix unreachable dead code in error event handling#2808
Open
yurekami wants to merge 1 commit intoopenai:mainfrom
Open
Fix unreachable dead code in error event handling#2808yurekami wants to merge 1 commit intoopenai:mainfrom
yurekami wants to merge 1 commit intoopenai:mainfrom
Conversation
The error event check (`sse.event == "error"`) was incorrectly placed
inside the `if sse.event.startswith("thread.")` block, making it
unreachable since "error" doesn't start with "thread.".
This fix:
- Moves the error event check to be before the thread.* event check
- Properly handles the ErrorObject structure from the Assistants API
- Adds regression tests for error event handling
Fixes openai#2796
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Collaborator
|
Should we also remove the error handling from the else block below? It seems like it’s basically doing the same thing if sse.event and sse.event.startswith("thread."):
yield process_data(data={"data": data, "event": sse.event}, cast_to=cast_to, response=response)
else:
data = sse.json() # <---- error handling
if is_mapping(data) and data.get("error"):
message = None
error = data.get("error")
if is_mapping(error):
message = error.get("message")
if not message or not isinstance(message, str):
message = "An error occurred during streaming"
raise APIError(
message=message,
request=self.response.request,
body=data["error"],
)We can also move sse.json() out of the if blocks and just call it once. |
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
_streaming.pywhere theerrorevent check was incorrectly placed inside thethread.*event handling blockProblem
In
src/openai/_streaming.py, the check forsse.event == "error"was placed inside theif sse.event.startswith("thread.")block. Since"error"doesn't start with"thread.", this condition could never be true, making lines 67-79 (sync) and 170-182 (async) unreachable dead code.This was identified as a regression from a previous refactoring commit.
Solution
Moved the error event check to be before the
thread.*check, so it's evaluated independently:Also simplified the error handling to correctly parse the
ErrorObjectstructure from the Assistants API (which hasmessagedirectly indata, not nested underdata.error).Test plan
test_error_event_raises_api_error- verifies error events raise APIError with correct messagetest_error_event_with_missing_message- verifies default message is used when message field is missingFixes #2796
🤖 Generated with Claude Code