Codec-compression: Add Zstd decompressor - #17152
Merged
Merged
Conversation
Extract the Zstd decompressor from the decompressor API draft and add the matching contract test. Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> Co-Authored-By: multicode <multicode@yawk.at>
Port the ZstdDecoder maxWindowLog guard to the decompressor API and use the shared forward-size for output chunks. Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> Co-Authored-By: multicode <multicode@yawk.at>
yawkat
marked this pull request as ready for review
July 27, 2026 14:01
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds Zstandard (Zstd) support to Netty’s new Decompressor API as part of the decompressor migration tracked in #16743, including contract tests and a guard to cap Zstd window memory usage via setLongMax(...).
Changes:
- Introduces
ZstdDecompressorbacked byzstd-jni’sZstdInputStreamNoFinalizer, including amaxWindowLog(int)builder option. - Adds
ZstdDecompressorTestextending the sharedAbstractDecompressorTestcontract suite and adds focused coverage for rejecting oversizedWindow_Log. - Uses the shared
CompressionUtil.DEFAULT_MAX_FORWARD_BYTESas the per-call output chunk size intakeOutput().
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| codec-compression/src/main/java/io/netty/handler/codec/compression/ZstdDecompressor.java | New Zstd implementation of the Decompressor API with configurable window-log cap and streaming output. |
| codec-compression/src/test/java/io/netty/handler/codec/compression/ZstdDecompressorTest.java | Adds contract coverage plus specific tests for maxWindowLog rejection/acceptance behavior using ZstdEncoder. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Fail fast when zstd-jni is unavailable and release empty Zstd decompressor input immediately. Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> Co-Authored-By: multicode <multicode@yawk.at>
chrisvest
reviewed
Jul 27, 2026
Clean up the Zstd stream if configuration fails and force the final zstd read on end-of-input so truncated frames are reported. Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> Co-Authored-By: multicode <multicode@yawk.at>
🚨 TestLens detected 1 failed test 🚨Here is what you can do:
Test SummaryBuild PR / macos-aarch64-java11-boringssl build > Netty/Transport/Native/KQueue
🏷️ Commit: 1310ac9 Test FailuresKQueueDatagramUnicastIPv6MappedTest > testSimpleSendWithConnect(TestInfo) (Netty/Transport/Native/KQueue in Build PR / macos-aarch64-java11-boringssl build)Muted TestsSelect tests to mute in this pull request:
Reuse successful test results:
Click the checkbox to trigger a rerun:
Learn more about TestLens at testlens.app. |
chrisvest
approved these changes
Jul 28, 2026
Contributor
|
Auto-port PR for 5.0: #17168 |
normanmaurer
pushed a commit
that referenced
this pull request
Aug 4, 2026
Auto-port of #17152 to 5.0 Cherry-picked commit: a4e5641 --- Motivation: The decompressor API migration tracked in #16743 is being split out from #15667 into smaller, reviewable pieces. This adds the Zstd decompressor slice on top of the core decompressor API that is already present, including the ZstdDecoder window-memory guard added in #16850. Modification: Add `ZstdDecompressor`, backed by zstd-jni `ZstdInputStreamNoFinalizer`, and add the matching `AbstractDecompressorTest` coverage using `ZstdEncoder`. The decompressor builder exposes `maxWindowLog(int)` and applies it through `ZstdInputStreamNoFinalizer.setLongMax(...)` so frames declaring oversized windows are rejected before zstd allocates excessive native memory. `takeOutput()` also uses the shared compression forward-size as its per-call output chunk size. Result: Zstd now has a decompressor implementation for the new API with focused contract coverage and bounded zstd native window memory by default. Verification: - `./mvnw -pl codec-compression -am -DskipRemoteStaging=true -Dcheckstyle.skip=false -DskipTests=false -Dtest=ZstdDecompressorTest -Dsurefire.failIfNoSpecifiedTests=false test` - `./mvnw -pl codec-compression -am -DskipRemoteStaging=true -Dcheckstyle.skip=false -DskipTests=false verify` Part of #16743. Co-authored-by: Jonas Konrad <jonas.konrad@oracle.com> Co-authored-by: multicode <multicode@yawk.at>
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.
Motivation:
The decompressor API migration tracked in #16743 is being split out from #15667 into smaller, reviewable pieces. This adds the Zstd decompressor slice on top of the core decompressor API that is already present, including the ZstdDecoder window-memory guard added in #16850.
Modification:
Add
ZstdDecompressor, backed by zstd-jniZstdInputStreamNoFinalizer, and add the matchingAbstractDecompressorTestcoverage usingZstdEncoder.The decompressor builder exposes
maxWindowLog(int)and applies it throughZstdInputStreamNoFinalizer.setLongMax(...)so frames declaring oversized windows are rejected before zstd allocates excessive native memory.takeOutput()also uses the shared compression forward-size as its per-call output chunk size.Result:
Zstd now has a decompressor implementation for the new API with focused contract coverage and bounded zstd native window memory by default.
Verification:
./mvnw -pl codec-compression -am -DskipRemoteStaging=true -Dcheckstyle.skip=false -DskipTests=false -Dtest=ZstdDecompressorTest -Dsurefire.failIfNoSpecifiedTests=false test./mvnw -pl codec-compression -am -DskipRemoteStaging=true -Dcheckstyle.skip=false -DskipTests=false verifyPart of #16743.