fix: Fix zstd decompression of multi-frame responses#12290
Open
josumoreno-BP wants to merge 2 commits intoaio-libs:masterfrom
Open
fix: Fix zstd decompression of multi-frame responses#12290josumoreno-BP wants to merge 2 commits intoaio-libs:masterfrom
josumoreno-BP wants to merge 2 commits intoaio-libs:masterfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #12290 +/- ##
=======================================
Coverage 99.11% 99.11%
=======================================
Files 130 130
Lines 45446 45524 +78
Branches 2398 2403 +5
=======================================
+ Hits 45043 45122 +79
Misses 272 272
+ Partials 131 130 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
ZstdDecompressor is one-shot-per-frame: once a frame ends, subsequent decompress() calls raise EOFError. This broke HTTP responses where the server sends multiple zstd frames (common with chunked transfer encoding). Detect frame boundaries via eof/unused_data attributes and create fresh decompressor instances for subsequent frames.
ddcc1f8 to
b0c4aec
Compare
| if zstd_max_length != ZSTD_MAX_LENGTH_UNLIMITED: | ||
| zstd_max_length -= len(result) | ||
| if zstd_max_length <= 0: | ||
| break |
Member
There was a problem hiding this comment.
I think we're missing an edge case, which probably needs a new test.
If we have unused data here and break, we've ended up throwing it away. Presumably when it continues with further data, it'll fail as the input is corrupted.
Member
|
Other than that subtle edge case, this looks very solid! |
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.
ZstdDecompressor is one-shot-per-frame: once a frame ends, subsequent decompress() calls raise EOFError. This broke HTTP responses where the server sends multiple zstd frames (common with chunked transfer encoding).
Detect frame boundaries via eof/unused_data attributes and create fresh decompressor instances for subsequent frames.
What do these changes do?
Detect frame boundaries via eof/unused_data attributes and create fresh decompressor instances for subsequent frames.
Are there changes in behavior for the user?
The change is seamless for the uses
Is it a substantial burden for the maintainers to support this?
I think this is needed to cover multi-framed zstd responses. I tried to keep it simple but covering the cases that came to my mind.
Related issue number
Fixes #12234
Checklist
CONTRIBUTORS.txtCHANGES/foldername it
<issue_or_pr_num>.<type>.rst(e.g.588.bugfix.rst)if you don't have an issue number, change it to the pull request
number after creating the PR
.bugfix: A bug fix for something the maintainers deemed animproper undesired behavior that got corrected to match
pre-agreed expectations.
.feature: A new behavior, public APIs. That sort of stuff..deprecation: A declaration of future API removals and breakingchanges in behavior.
.breaking: When something public is removed in a breaking way.Could be deprecated in an earlier release.
.doc: Notable updates to the documentation structure or buildprocess.
.packaging: Notes for downstreams about unobvious side effectsand tooling. Changes in the test invocation considerations and
runtime assumptions.
.contrib: Stuff that affects the contributor experience. e.g.Running tests, building the docs, setting up the development
environment.
.misc: Changes that are hard to assign to any of the abovecategories.
Make sure to use full sentences with correct case and punctuation,
for example:
Use the past tense or the present tense a non-imperative mood,
referring to what's changed compared to the last released version
of this project.