mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-14 12:20:24 +00:00
Add deflate options for Websocket compression
They allow the server to configure what it is willing to accept for both the negotiated configuration (takeover and window bits) and the other zlib options (level, mem_level and strategy). This can be used to reduce the memory and/or CPU footprint of the compressed data, which comes with a cost in compression ratio.
This commit is contained in:
Loïc Hoguin
parent
fe1ee080de
commit
8164b50453
4 changed files with 220 additions and 50 deletions
|
|
@ -83,7 +83,8 @@ init_dispatch() ->
|
|||
{"/terminate", ws_terminate_h, []},
|
||||
{"/ws_timeout_hibernate", ws_timeout_hibernate, []},
|
||||
{"/ws_timeout_cancel", ws_timeout_cancel, []},
|
||||
{"/ws_max_frame_size", ws_max_frame_size, []}
|
||||
{"/ws_max_frame_size", ws_max_frame_size, []},
|
||||
{"/ws_deflate_opts", ws_deflate_opts_h, []}
|
||||
]}
|
||||
]).
|
||||
|
||||
|
|
@ -231,6 +232,123 @@ do_ws_version(Socket) ->
|
|||
{error, closed} = gen_tcp:recv(Socket, 0, 6000),
|
||||
ok.
|
||||
|
||||
ws_deflate_opts_client_context_takeover(Config) ->
|
||||
doc("Handler is configured with client context takeover enabled."),
|
||||
{ok, _, Headers1} = do_handshake("/ws_deflate_opts?client_context_takeover",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate\r\n", Config),
|
||||
{_, "permessage-deflate"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers1),
|
||||
{ok, _, Headers2} = do_handshake("/ws_deflate_opts?client_context_takeover",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate; client_no_context_takeover\r\n", Config),
|
||||
{_, "permessage-deflate; client_no_context_takeover"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers2),
|
||||
ok.
|
||||
|
||||
ws_deflate_opts_client_no_context_takeover(Config) ->
|
||||
doc("Handler is configured with client context takeover disabled."),
|
||||
{ok, _, Headers1} = do_handshake("/ws_deflate_opts?client_no_context_takeover",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate\r\n", Config),
|
||||
{_, "permessage-deflate; client_no_context_takeover"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers1),
|
||||
{ok, _, Headers2} = do_handshake("/ws_deflate_opts?client_no_context_takeover",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate; client_no_context_takeover\r\n", Config),
|
||||
{_, "permessage-deflate; client_no_context_takeover"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers2),
|
||||
ok.
|
||||
|
||||
%% We must send client_max_window_bits to indicate we support it.
|
||||
ws_deflate_opts_client_max_window_bits(Config) ->
|
||||
doc("Handler is configured with client max window bits."),
|
||||
{ok, _, Headers} = do_handshake("/ws_deflate_opts?client_max_window_bits",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits\r\n", Config),
|
||||
{_, "permessage-deflate; client_max_window_bits=9"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers),
|
||||
ok.
|
||||
|
||||
ws_deflate_opts_client_max_window_bits_override(Config) ->
|
||||
doc("Handler is configured with client max window bits."),
|
||||
{ok, _, Headers1} = do_handshake("/ws_deflate_opts?client_max_window_bits",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits=8\r\n", Config),
|
||||
{_, "permessage-deflate; client_max_window_bits=8"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers1),
|
||||
{ok, _, Headers2} = do_handshake("/ws_deflate_opts?client_max_window_bits",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits=12\r\n", Config),
|
||||
{_, "permessage-deflate; client_max_window_bits=9"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers2),
|
||||
ok.
|
||||
|
||||
ws_deflate_opts_server_context_takeover(Config) ->
|
||||
doc("Handler is configured with server context takeover enabled."),
|
||||
{ok, _, Headers1} = do_handshake("/ws_deflate_opts?server_context_takeover",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate\r\n", Config),
|
||||
{_, "permessage-deflate"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers1),
|
||||
{ok, _, Headers2} = do_handshake("/ws_deflate_opts?server_context_takeover",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate; server_no_context_takeover\r\n", Config),
|
||||
{_, "permessage-deflate; server_no_context_takeover"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers2),
|
||||
ok.
|
||||
|
||||
ws_deflate_opts_server_no_context_takeover(Config) ->
|
||||
doc("Handler is configured with server context takeover disabled."),
|
||||
{ok, _, Headers1} = do_handshake("/ws_deflate_opts?server_no_context_takeover",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate\r\n", Config),
|
||||
{_, "permessage-deflate; server_no_context_takeover"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers1),
|
||||
{ok, _, Headers2} = do_handshake("/ws_deflate_opts?server_no_context_takeover",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate; server_no_context_takeover\r\n", Config),
|
||||
{_, "permessage-deflate; server_no_context_takeover"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers2),
|
||||
ok.
|
||||
|
||||
ws_deflate_opts_server_max_window_bits(Config) ->
|
||||
doc("Handler is configured with server max window bits."),
|
||||
{ok, _, Headers} = do_handshake("/ws_deflate_opts?server_max_window_bits",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate\r\n", Config),
|
||||
{_, "permessage-deflate; server_max_window_bits=9"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers),
|
||||
ok.
|
||||
|
||||
ws_deflate_opts_server_max_window_bits_override(Config) ->
|
||||
doc("Handler is configured with server max window bits."),
|
||||
{ok, _, Headers1} = do_handshake("/ws_deflate_opts?server_max_window_bits",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=8\r\n", Config),
|
||||
{_, "permessage-deflate; server_max_window_bits=8"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers1),
|
||||
{ok, _, Headers2} = do_handshake("/ws_deflate_opts?server_max_window_bits",
|
||||
"Sec-WebSocket-Extensions: permessage-deflate; server_max_window_bits=12\r\n", Config),
|
||||
{_, "permessage-deflate; server_max_window_bits=9"}
|
||||
= lists:keyfind("sec-websocket-extensions", 1, Headers2),
|
||||
ok.
|
||||
|
||||
ws_deflate_opts_zlevel(Config) ->
|
||||
doc("Handler is configured with zlib level."),
|
||||
do_ws_deflate_opts_z("/ws_deflate_opts?level", Config).
|
||||
|
||||
ws_deflate_opts_zmemlevel(Config) ->
|
||||
doc("Handler is configured with zlib mem_level."),
|
||||
do_ws_deflate_opts_z("/ws_deflate_opts?mem_level", Config).
|
||||
|
||||
ws_deflate_opts_zstrategy(Config) ->
|
||||
doc("Handler is configured with zlib strategy."),
|
||||
do_ws_deflate_opts_z("/ws_deflate_opts?strategy", Config).
|
||||
|
||||
do_ws_deflate_opts_z(Path, Config) ->
|
||||
{ok, Socket, Headers} = do_handshake(Path,
|
||||
"Sec-WebSocket-Extensions: permessage-deflate\r\n", Config),
|
||||
{_, "permessage-deflate"} = lists:keyfind("sec-websocket-extensions", 1, Headers),
|
||||
%% Send and receive a compressed "Hello" frame.
|
||||
Mask = 16#11223344,
|
||||
CompressedHello = << 242, 72, 205, 201, 201, 7, 0 >>,
|
||||
MaskedHello = do_mask(CompressedHello, Mask, <<>>),
|
||||
ok = gen_tcp:send(Socket, << 1:1, 1:1, 0:2, 1:4, 1:1, 7:7, Mask:32, MaskedHello/binary >>),
|
||||
{ok, << 1:1, 1:1, 0:2, 1:4, 0:1, 7:7, CompressedHello/binary >>} = gen_tcp:recv(Socket, 0, 6000),
|
||||
%% Client-initiated close.
|
||||
ok = gen_tcp:send(Socket, << 1:1, 0:3, 8:4, 1:1, 0:7, 0:32 >>),
|
||||
{ok, << 1:1, 0:3, 8:4, 0:8 >>} = gen_tcp:recv(Socket, 0, 6000),
|
||||
{error, closed} = gen_tcp:recv(Socket, 0, 6000),
|
||||
ok.
|
||||
|
||||
ws_init_return_ok(Config) ->
|
||||
doc("Handler does nothing."),
|
||||
{ok, Socket, _} = do_handshake("/ws_init?ok", Config),
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue