fix(streaming): remove unreachable sse.event == error check#2844
Open
Mr-Neutr0n wants to merge 1 commit intoopenai:mainfrom
Open
fix(streaming): remove unreachable sse.event == error check#2844Mr-Neutr0n wants to merge 1 commit intoopenai:mainfrom
Mr-Neutr0n wants to merge 1 commit intoopenai:mainfrom
Conversation
The `sse.event == "error"` condition was inside a block that requires
`sse.event.startswith("thread.")`. Since "error" does not start with
"thread.", this check was always False and unreachable.
Changed from:
if sse.event == "error" and is_mapping(data) and data.get("error"):
To:
if is_mapping(data) and data.get("error"):
This allows error detection for thread.* events by checking the data
payload instead of the event name, consistent with how errors are
handled in the else branch for non-thread events.
Fixes both sync (line 67) and async (line 170) versions.
Fixes openai#2796
Author
|
Friendly follow-up - is there anything I can improve in this PR? Happy to address any feedback. |
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
Fixes dead code bug where the
sse.event == "error"condition was unreachable.Problem
The
sse.event == "error"check was nested inside a block that requiressse.event.startswith("thread."):Since
"error"does not start with"thread.", this condition can never be True.Solution
Changed the check to look for error data in the payload rather than the event name:
This is consistent with how errors are handled in the
elsebranch for non-thread events (lines 84-96).Changes
src/openai/_streaming.py: Fixed both sync (line 67) and async (line 170) versionsTest Plan
Fixes #2796