Allow selecting individual WebSocket messages for compression - #14127
Merged
Conversation
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.
This PR lets applications decide whether each outbound WebSocket text or binary message should be compressed.
WebSocket.Acceptednow accepts ashouldCompressselector in both the Scala and Java APIs. The selector receives aCompressionContextcontaining:play.server.websocket.compression.thresholdReturning
trueorfalseoverrides the configured threshold for that message.This allows applications to avoid compressing sensitive or already-compressed content while continuing to compress other messages on the same WebSocket connection.
Behavior
The selector:
permessage-deflatewas negotiatedThe default selector preserves the existing threshold behavior.
Implementation
The selector is propagated through message-flow transformations and the Java-to-Scala API bridge.
Both server backends support it:
Tests
Shared integration tests for both backends verify:
Scala and Java WebSocket documentation and the Play release highlights are updated.
References