Address cases where MultipartEncoder source stream grows or shrinks mid-way through encoding, leading to malformed requests #314
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
…id-way through encoding Previously, MultipartEncoder in conjunction with requests could produce a malformed request if the source data stream grew (e.g. appending to a log file being uploaded) or shrunk during encoding. This change addresses both the growing case (by only transmitting the originally promised amount of data) and the shrinking case (by raising an exception).
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.
Previously, MultipartEncoder in conjunction with requests could produce a malformed request if the source data stream grew (e.g. appending to a log file being uploaded) or shrunk during encoding. This change addresses both the growing case (by only transmitting the originally promised amount of data) and the shrinking case (by raising an exception).
Note that the data produced by MultipartEncoder itself was well formed. The issue occurs when downstream code makes promises or assumptions based on the initial
len(e.g. transmitting it to the server asContent-Length, as requests does), only to have the encoder return more/less data. This change may break (presumably rare) use cases that rely on both a) on shrinking/growing the source data stream during encoding, and b) don't already fail due to the promised/actual encoded data length mismatch.