Fix streaming hang when session.add_items raises an exception #2131
Conversation
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.
Resolved: 2130
This PR fixes a bug where
Runner.run_streamed()could hang forever ifsession.add_items()raises an exception during streaming.Root cause
When an exception happens in the outer error handling of
_start_streaming, the completion sentinel is not sent. Because of that, the event queue never receivesQueueCompleteSentinel, andstream_events()waits forever.Solution
This PR marks the stream as complete in the outer error handling when
is_completeis stillFalse, so the stream will not hang and the exception can be raised to the caller.A regression test is added to make sure exceptions are properly raised instead of causing the stream to hang.