Make WebSocket compression actually work#414
Open
robert-s-ubi wants to merge 2 commits intomasterfrom
Open
Conversation
This was referenced Dec 24, 2025
A new PerMessageDeflateExtension was contributed to the Java-WebSocket project, but no new release of that library has been made since. Add a copy of the new implementation with an adapted package path and use that instead of the old version from Java-WebSocket 1.6.0. This is intended to be a temporary measure until a newer release of the Java-WebSocket library is made. When that is updated, this change can be reverted.
Add a new JSON configuration parameter "WEBSOCKET_MAX_FRAME_SIZE" to set a limit for the maximum WebSocket frame size, as especially with the new compression support, unbounded frame sizes pose a risk. The default is left at 0 (unbounded) to keep compatibility with all existing uses, but it is strongly recommended to set an appropriate limit. Add a new API MultiProtocolJSONClient#getCompressionRatio() to retrieve the current compression ratio for informational purposes. Increase the WebSocket compression threshold from 0 to 64 bytes, as it was observed that frames smaller than 64 bytes typically grow in size when compression is applied.
robert-s-ubi
force-pushed
the
fix_websocket_compression
branch
from
f525dd8 to
2574c41
Compare
Contributor
Author
|
@TVolden could you maybe review this PR as well? It is mostly using the bugfixed websocket per-message implementation I contributed to the dependency project (TooTallNate/Java-WebSocket#1498) where it has been merged, but not released since. Since the current state is rather broken, I would not want to wait any longer for them to make a release to fix this library. |
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
1 participant
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.
A new PerMessageDeflateExtension was contributed to the Java-WebSocket
project, but no new release of that library has been made since.
Add a copy of the new implementation with an adapted package path and
use that instead of the old version from Java-WebSocket 1.6.0.
Add a new JSON configuration parameter "WEBSOCKET_MAX_FRAME_SIZE" to set
a limit for the maximum WebSocket frame size, as especially with the new
compression support, unbounded frame sizes pose a risk. The default is
left at 0 (unbounded) to keep compatibility with all existing uses, but
it is strongly recommended to set an appropriate limit.
Add a new API MultiProtocolJSONClient#getCompressionRatio() to retrieve
the current compression ratio for informational purposes.
Increase the WebSocket compression threshold from 0 to 64 bytes, as it
was observed that frames smaller than 64 bytes typically grow in size
when compression is applied.