Update documentation of gzip bufferSize property #8755
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
The documentation for the gzip bufferSize property mentions it is used for compressing. It is actually used for decompressing requests. The bufferSize property in GzipHandlerFactory is passed to the setInflateBufferSize method of GzipHandler [1]. Per the documentation of the setInflateBufferSize [2]: > Set the size (in bytes) of the Inflater buffer used to inflate comrpessed requests. [1] https://github.com/dropwizard/dropwizard/blob/d3dd6fc3677cd2b84c5018f1e8cdef3a969db2c3/dropwizard-jetty/src/main/java/io/dropwizard/jetty/GzipHandlerFactory.java#L247 [2] https://eclipse.dev/jetty/javadoc/jetty-11/org/eclipse/jetty/server/handler/gzip/GzipHandler.html#setInflateBufferSize(int)
tbcardoso
force-pushed
the
release/4.0.x-gzip-bufferSize-docs
branch
from
c7e720e
to
cc44232
Compare
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.
Problem:
The documentation for the gzip
bufferSizeproperty mentions it is used for compressing. It is actually used for decompressing requests.The
bufferSizeproperty in GzipHandlerFactory is passed to thesetInflateBufferSizemethod of GzipHandler.Per the documentation of the setInflateBufferSize:
Solution:
Just fix the documentation of the bufferSize property to mention
decompressinginstead ofcompressing.