Enabling Compression to Websocket on Netty

[TheAntimist]

Play Version

2.8.8

API

Java

Operating System

Windows and Linux

JDK

~/ java -version
openjdk version "13.0.1" 2019-10-15
OpenJDK Runtime Environment (build 13.0.1+9)
OpenJDK 64-Bit Server VM (build 13.0.1+9, mixed mode, sharing)

Actual Behavior

I am currently implementing a websocket server in Play. As part of doing that I noted that the server does not support the permessage-deflate Websocket Extension.

Netty had added this as part of their 4.1 release . An example of a server implementation is here .

Possible Solution

I went over the codebase, and found that using the ChannelPipeline object during the handshake here, HttpStreamsServerHandler.java#L187 to add the WebSocketServerCompressionHandler could work.

Although, I cannot be certain if this would work or be the right way to achieve it, I could surely raise a PR, if someone pointed me in the right direction.

EDIT: I just checked that this was a duplicate of #4186 . But would like to atleast get a response on how to move forward before closing this issue.

[prongs]

Hey @TheAntimist did you manage to get it to work?

[mkurz]

Let's add this to the 2.9 release

[TheAntimist]

@prongs Unfortunately not yet.
@mkurz Awesome! Let me try and get a prototype PR out during the upcoming holidays.

[mkurz]

Let me try and get a prototype PR out during the upcoming holidays.

@TheAntimist Sure 😉 I am happy to review.

[mkurz]

@TheAntimist Will you work on this?

[TheAntimist]

@mkurz I started work on it, but got covid. Just getting recovered and starting work on this again soon.

[mkurz]

@TheAntimist Oh, I am sorry, hope you get better soon! I didn't want to push you, just asking if there is still interest. Take your time.

[TheAntimist]

@mkurz No worries, I intended on getting it done earlier. I will try to finish this within the upcoming 2-3 weeks once I get recovered.

[TheAntimist]

@mkurz Just to let you know I've started working on this again last week. Been testing it and checking a few things, hopefully I'll get it completed soon.