0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 12:20:24 +00:00

Add the set_options stream handler command

The first two options to benefit from this are the
cowboy_compress_h options.
This commit is contained in:
Loïc Hoguin 2018-11-15 18:53:42 +01:00
parent fbfec873f6
commit 240da3f2d9
No known key found for this signature in database
GPG key ID: 8A9DF795F6FED764
5 changed files with 151 additions and 39 deletions

View file

@ -149,53 +149,132 @@ gzip_stream_reply_content_encoding(Config) ->
opts_compress_buffering_false(Config0) ->
doc("Confirm that the compress_buffering option can be set to false, "
"which is the default."),
Name = name(),
Fun = case config(ref, Config0) of
https_compress -> init_https;
h2_compress -> init_http2;
_ -> init_http
end,
Config = cowboy_test:Fun(name(), #{
Config = cowboy_test:Fun(Name, #{
env => #{dispatch => init_dispatch(Config0)},
stream_handlers => [cowboy_compress_h, cowboy_stream_h],
compress_buffering => false
}, Config0),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/stream_reply/delayed",
[{<<"accept-encoding">>, <<"gzip">>}]),
{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"gzip">>} = lists:keyfind(<<"content-encoding">>, 1, Headers),
Z = zlib:open(),
zlib:inflateInit(Z, 31),
{data, nofin, Data1} = gun:await(ConnPid, Ref, 100),
<<"data: Hello!\r\n\r\n">> = iolist_to_binary(zlib:inflate(Z, Data1)),
timer:sleep(1000),
{data, nofin, Data2} = gun:await(ConnPid, Ref, 100),
<<"data: World!\r\n\r\n">> = iolist_to_binary(zlib:inflate(Z, Data2)),
gun:close(ConnPid),
cowboy:stop_listener(name()).
try
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/stream_reply/delayed",
[{<<"accept-encoding">>, <<"gzip">>}]),
{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"gzip">>} = lists:keyfind(<<"content-encoding">>, 1, Headers),
Z = zlib:open(),
zlib:inflateInit(Z, 31),
{data, nofin, Data1} = gun:await(ConnPid, Ref, 100),
<<"data: Hello!\r\n\r\n">> = iolist_to_binary(zlib:inflate(Z, Data1)),
timer:sleep(1000),
{data, nofin, Data2} = gun:await(ConnPid, Ref, 100),
<<"data: World!\r\n\r\n">> = iolist_to_binary(zlib:inflate(Z, Data2)),
gun:close(ConnPid)
after
cowboy:stop_listener(Name)
end.
opts_compress_buffering_true(Config0) ->
doc("Confirm that the compress_buffering option can be set to true, "
"and that the data received is buffered."),
Name = name(),
Fun = case config(ref, Config0) of
https_compress -> init_https;
h2_compress -> init_http2;
_ -> init_http
end,
Config = cowboy_test:Fun(name(), #{
Config = cowboy_test:Fun(Name, #{
env => #{dispatch => init_dispatch(Config0)},
stream_handlers => [cowboy_compress_h, cowboy_stream_h],
compress_buffering => true
}, Config0),
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/stream_reply/delayed",
[{<<"accept-encoding">>, <<"gzip">>}]),
{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
try
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/stream_reply/delayed",
[{<<"accept-encoding">>, <<"gzip">>}]),
{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"gzip">>} = lists:keyfind(<<"content-encoding">>, 1, Headers),
Z = zlib:open(),
zlib:inflateInit(Z, 31),
%% The data gets buffered because it is too small.
{data, nofin, Data1} = gun:await(ConnPid, Ref, 100),
<<>> = iolist_to_binary(zlib:inflate(Z, Data1)),
gun:close(ConnPid)
after
cowboy:stop_listener(Name)
end.
set_options_compress_buffering_false(Config0) ->
doc("Confirm that the compress_buffering option can be dynamically "
"set to false by a handler and that the data received is not buffered."),
Name = name(),
Fun = case config(ref, Config0) of
https_compress -> init_https;
h2_compress -> init_http2;
_ -> init_http
end,
Config = cowboy_test:Fun(Name, #{
env => #{dispatch => init_dispatch(Config0)},
stream_handlers => [cowboy_compress_h, cowboy_stream_h],
compress_buffering => true
}, Config0),
try
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/stream_reply/set_options_buffering_false",
[{<<"accept-encoding">>, <<"gzip">>}]),
{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"gzip">>} = lists:keyfind(<<"content-encoding">>, 1, Headers),
Z = zlib:open(),
zlib:inflateInit(Z, 31),
{data, nofin, Data1} = gun:await(ConnPid, Ref, 100),
<<"data: Hello!\r\n\r\n">> = iolist_to_binary(zlib:inflate(Z, Data1)),
timer:sleep(1000),
{data, nofin, Data2} = gun:await(ConnPid, Ref, 100),
<<"data: World!\r\n\r\n">> = iolist_to_binary(zlib:inflate(Z, Data2)),
gun:close(ConnPid)
after
cowboy:stop_listener(Name)
end.
set_options_compress_buffering_true(Config0) ->
doc("Confirm that the compress_buffering option can be dynamically "
"set to true by a handler and that the data received is buffered."),
Name = name(),
Fun = case config(ref, Config0) of
https_compress -> init_https;
h2_compress -> init_http2;
_ -> init_http
end,
Config = cowboy_test:Fun(Name, #{
env => #{dispatch => init_dispatch(Config0)},
stream_handlers => [cowboy_compress_h, cowboy_stream_h],
compress_buffering => false
}, Config0),
try
ConnPid = gun_open(Config),
Ref = gun:get(ConnPid, "/stream_reply/set_options_buffering_true",
[{<<"accept-encoding">>, <<"gzip">>}]),
{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"gzip">>} = lists:keyfind(<<"content-encoding">>, 1, Headers),
Z = zlib:open(),
zlib:inflateInit(Z, 31),
%% The data gets buffered because it is too small.
{data, nofin, Data1} = gun:await(ConnPid, Ref, 100),
<<>> = iolist_to_binary(zlib:inflate(Z, Data1)),
gun:close(ConnPid)
after
cowboy:stop_listener(Name)
end.
set_options_compress_threshold_0(Config) ->
doc("Confirm that the compress_threshold option can be dynamically "
"set to change how large response bodies must be to be compressed."),
{200, Headers, GzBody} = do_get("/reply/set_options_threshold0",
[{<<"accept-encoding">>, <<"gzip">>}], Config),
{_, <<"gzip">>} = lists:keyfind(<<"content-encoding">>, 1, Headers),
Z = zlib:open(),
zlib:inflateInit(Z, 31),
%% The data gets buffered because it is too small.
{data, nofin, Data1} = gun:await(ConnPid, Ref, 100),
<<>> = iolist_to_binary(zlib:inflate(Z, Data1)),
gun:close(ConnPid),
cowboy:stop_listener(name()).
_ = zlib:gunzip(GzBody),
ok.

View file

@ -19,7 +19,12 @@ init(Req0, State=reply) ->
<<"sendfile">> ->
AppFile = code:where_is_file("cowboy.app"),
Size = filelib:file_size(AppFile),
cowboy_req:reply(200, #{}, {sendfile, 0, Size, AppFile}, Req0)
cowboy_req:reply(200, #{}, {sendfile, 0, Size, AppFile}, Req0);
<<"set_options_threshold0">> ->
%% @todo This should be replaced by a cowboy_req:cast/cowboy_stream:cast.
#{pid := Pid, streamid := StreamID} = Req0,
Pid ! {{Pid, StreamID}, {set_options, #{compress_threshold => 0}}},
cowboy_req:reply(200, #{}, lists:duplicate(100, $a), Req0)
end,
{ok, Req, State};
init(Req0, State=stream_reply) ->
@ -52,13 +57,17 @@ init(Req0, State=stream_reply) ->
cowboy_req:stream_body({sendfile, 0, Size, AppFile}, fin, Req1),
Req1;
<<"delayed">> ->
Req1 = cowboy_req:stream_reply(200, Req0),
cowboy_req:stream_body(<<"data: Hello!\r\n\r\n">>, nofin, Req1),
timer:sleep(1000),
cowboy_req:stream_body(<<"data: World!\r\n\r\n">>, nofin, Req1),
timer:sleep(1000),
cowboy_req:stream_body(<<"data: Closing!\r\n\r\n">>, fin, Req1),
Req1
stream_delayed(Req0);
<<"set_options_buffering_false">> ->
%% @todo This should be replaced by a cowboy_req:cast/cowboy_stream:cast.
#{pid := Pid, streamid := StreamID} = Req0,
Pid ! {{Pid, StreamID}, {set_options, #{compress_buffering => false}}},
stream_delayed(Req0);
<<"set_options_buffering_true">> ->
%% @todo This should be replaced by a cowboy_req:cast/cowboy_stream:cast.
#{pid := Pid, streamid := StreamID} = Req0,
Pid ! {{Pid, StreamID}, {set_options, #{compress_buffering => true}}},
stream_delayed(Req0)
end,
{ok, Req, State}.
@ -68,3 +77,12 @@ stream_reply(Headers, Req0) ->
_ = [cowboy_req:stream_body(Data, nofin, Req) || _ <- lists:seq(1,9)],
cowboy_req:stream_body(Data, fin, Req),
Req.
stream_delayed(Req0) ->
Req = cowboy_req:stream_reply(200, Req0),
cowboy_req:stream_body(<<"data: Hello!\r\n\r\n">>, nofin, Req),
timer:sleep(1000),
cowboy_req:stream_body(<<"data: World!\r\n\r\n">>, nofin, Req),
timer:sleep(1000),
cowboy_req:stream_body(<<"data: Closing!\r\n\r\n">>, fin, Req),
Req.