fix(asgi.BoundedStream): Mixing iteration and read() can lead to subtle errors #1692
Conversation
This file contains 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
…le errors This patch does three things to make BoundedStream more robust and debuggable: 1. Disallow re-iteration over the stream when an iteration is already in progress. 2. Yield anything in the buffer first, before awaiting additional body events, when iterating over a stream that was partially read before the iteration began. 3. Introduce a custom subclass of ValueError, OperationNotAllowed, that can be raised to give the developer a more obvious hint as to what went wrong.
Codecov Report
@@ Coverage Diff @@
## master #1692 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 47 47
Lines 3537 3548 +11
Branches 548 550 +2
=========================================
+ Hits 3537 3548 +11 Continue to review full report at Codecov.
|
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 of Changes
This patch does three things to make BoundedStream more robust and debuggable:
when iterating over a stream that was partially read before the iteration
began.
can be raised to give the developer a more obvious hint as to what
went wrong.
Related Issues
#1358