spring-cloud/spring-cloud-gateway

How to enable websocket compression (permessage-deflate) for proxied websocket ?

Open

#1,039 opened on Apr 30, 2019

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Java (4,284 stars) (3,204 forks)batch import
enhancementhelp wanted

Description

I have websocket behind cloud gateway. How to enable permessage-deflate compression on gateway? when I connect directly do websocket compression works, but gateway just ignores request header:

Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits

Contributor guide

Tech stack
java
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaSpring Cloud GatewayWebSocketProxy configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
This issue requests enabling WebSocket permessage deflate compression for proxied connections in spring cloud gateway. The user reports that direct connections work but the gateway ignores the Sec WebSocket Extensions header. To implement this, investigate the WebSocket handshake handling in the gateway's filter chain, specifically the WebSocket routing filter and related configuration classes (e.g., GatewayWebSocketHandler). Consider adding support for forwarding custom headers or configuring compression via properties. Check existing issues or PRs for similar work to avoid duplication.