Repository navigation
docs: document the Jackson compression max-decompressed-size limit - #3597
Merged
Merged
Conversation
Motivation: The Compression section of serialization-jackson.md does not mention compression.max-decompressed-size, which bounds how large a compressed payload may become when it is decompressed during deserialization. Modification: Describe the setting: default unlimited (negative values also mean unlimited), applies to gzip and lz4 payloads regardless of the algorithm setting, can be set for all bindings or per binding, rejects oversized payloads with an IllegalArgumentException, exists under pekko.serialization.jackson3 too, and is separate from pekko.serialization.max-decompressed-size, which does not apply to the Jackson serializers. Result: Users can find and configure the decompression limit for the Jackson serializers. Tests: - Not run - docs only References: None - found during a review of the docs; checked against the serialization-jackson and serialization-jackson3 reference.conf and JacksonSerializer
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 Compression section of serialization-jackson.md does not mention
compression.max-decompressed-size, which bounds how large a compressed
payload may become when it is decompressed during deserialization.
Modification
Describe the setting: default unlimited (negative values also mean
unlimited), applies to gzip and lz4 payloads regardless of the
algorithm setting, can be set for all bindings or per binding, rejects
oversized payloads with an IllegalArgumentException, exists under
pekko.serialization.jackson3 too, and is separate from
pekko.serialization.max-decompressed-size, which does not apply to the
Jackson serializers.
Result
Users can find and configure the decompression limit for the Jackson
serializers.
Tests
References
None - found during a review of the docs; checked against the
serialization-jackson and serialization-jackson3 reference.conf and
JacksonSerializer