0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 04:10:24 +00:00
cowboy/test/http_SUITE.erl
Loïc Hoguin 8e121d138c
Fix request_timeout triggering when a request was in the buffer
The problem was that when a request immediately following another
request with a large enough body, the data for the new request
(including headers) would be buffered waiting for more data,
instead of being processed immediately. If no more data came
in on the socket the request_timeout would eventually trigger.
Now the buffer is processed immediately.
2025-02-06 12:18:59 +01:00

858 lines
30 KiB
Erlang

%% Copyright (c) 2018-2024, Loïc Hoguin <essen@ninenines.eu>
%%
%% Permission to use, copy, modify, and/or distribute this software for any
%% purpose with or without fee is hereby granted, provided that the above
%% copyright notice and this permission notice appear in all copies.
%%
%% THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
%% WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
%% MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
%% ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
%% WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
%% ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
%% OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-module(http_SUITE).
-compile(export_all).
-compile(nowarn_export_all).
-import(ct_helper, [config/2]).
-import(ct_helper, [doc/1]).
-import(ct_helper, [get_remote_pid_tcp/1]).
-import(cowboy_test, [gun_open/1]).
-import(cowboy_test, [gun_down/1]).
-import(cowboy_test, [raw_open/1]).
-import(cowboy_test, [raw_send/2]).
-import(cowboy_test, [raw_recv_head/1]).
-import(cowboy_test, [raw_recv_rest/3]).
-import(cowboy_test, [raw_recv/3]).
-import(cowboy_test, [raw_expect_recv/2]).
all() -> [{group, clear}].
groups() -> [{clear, [parallel], ct_helper:all(?MODULE)}].
init_per_group(Name, Config) ->
cowboy_test:init_http(Name, #{
env => #{dispatch => init_dispatch(Config)}
}, Config).
end_per_group(Name, _) ->
cowboy:stop_listener(Name).
init_dispatch(_) ->
cowboy_router:compile([{"localhost", [
{"/", hello_h, []},
{"/delay_hello", delay_hello_h, #{delay => 1000, notify_received => self()}},
{"/echo/:key", echo_h, []},
{"/resp/:key[/:arg]", resp_h, []},
{"/set_options/:key", set_options_h, []},
{"/streamed_result/:n/:interval", streamed_result_h, []}
]}]).
chunked_false(Config) ->
doc("Confirm the option chunked => false disables chunked "
"transfer-encoding for HTTP/1.1 connections."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
chunked => false
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
Request = "GET /resp/stream_reply2/200 HTTP/1.1\r\nhost: localhost\r\n\r\n",
Client = raw_open([{type, tcp}, {port, Port}, {opts, []}|Config]),
ok = raw_send(Client, Request),
Rest = case catch raw_recv_head(Client) of
{'EXIT', _} -> error(closed);
Data ->
%% Cowboy always advertises itself as HTTP/1.1.
{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
{Headers, Rest1} = cow_http:parse_headers(Rest0),
false = lists:keyfind(<<"content-length">>, 1, Headers),
false = lists:keyfind(<<"transfer-encoding">>, 1, Headers),
Rest1
end,
Bits = 8000000 - bit_size(Rest),
raw_expect_recv(Client, <<0:Bits>>),
{error, closed} = raw_recv(Client, 1, 1000)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
chunked_one_byte_at_a_time(Config) ->
doc("Confirm that chunked transfer-encoding works when "
"the body is received one byte at a time."),
Body = list_to_binary(io_lib:format("~p", [lists:seq(1, 100)])),
ChunkedBody = iolist_to_binary(do_chunked_body(50, Body, [])),
Client = raw_open(Config),
ok = raw_send(Client,
"POST /echo/read_body HTTP/1.1\r\n"
"Host: localhost\r\n"
"Transfer-encoding: chunked\r\n\r\n"),
_ = [begin
raw_send(Client, <<C>>),
timer:sleep(1)
end || <<C>> <= ChunkedBody],
Rest = case catch raw_recv_head(Client) of
{'EXIT', _} -> error(closed);
Data ->
{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
{_, Rest1} = cow_http:parse_headers(Rest0),
Rest1
end,
RestSize = byte_size(Rest),
<<Rest:RestSize/binary, Expect/bits>> = Body,
raw_expect_recv(Client, Expect).
chunked_one_chunk_at_a_time(Config) ->
doc("Confirm that chunked transfer-encoding works when "
"the body is received one chunk at a time."),
Body = list_to_binary(io_lib:format("~p", [lists:seq(1, 100)])),
Chunks = do_chunked_body(50, Body, []),
Client = raw_open(Config),
ok = raw_send(Client,
"POST /echo/read_body HTTP/1.1\r\n"
"Host: localhost\r\n"
"Transfer-encoding: chunked\r\n\r\n"),
_ = [begin
raw_send(Client, Chunk),
timer:sleep(10)
end || Chunk <- Chunks],
Rest = case catch raw_recv_head(Client) of
{'EXIT', _} -> error(closed);
Data ->
{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
{_, Rest1} = cow_http:parse_headers(Rest0),
Rest1
end,
RestSize = byte_size(Rest),
<<Rest:RestSize/binary, Expect/bits>> = Body,
raw_expect_recv(Client, Expect).
chunked_split_delay_in_chunk_body(Config) ->
doc("Confirm that chunked transfer-encoding works when "
"the body is received with a delay inside the chunks."),
Body = list_to_binary(io_lib:format("~p", [lists:seq(1, 100)])),
Chunks = do_chunked_body(50, Body, []),
Client = raw_open(Config),
ok = raw_send(Client,
"POST /echo/read_body HTTP/1.1\r\n"
"Host: localhost\r\n"
"Transfer-encoding: chunked\r\n\r\n"),
_ = [begin
case Chunk of
<<"0\r\n\r\n">> ->
raw_send(Client, Chunk);
_ ->
[Size, ChunkBody, <<>>] = binary:split(Chunk, <<"\r\n">>, [global]),
PartASize = rand:uniform(byte_size(ChunkBody)),
<<PartA:PartASize/binary, PartB/binary>> = ChunkBody,
raw_send(Client, [Size, <<"\r\n">>, PartA]),
timer:sleep(10),
raw_send(Client, [PartB, <<"\r\n">>])
end
end || Chunk <- Chunks],
Rest = case catch raw_recv_head(Client) of
{'EXIT', _} -> error(closed);
Data ->
{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
{_, Rest1} = cow_http:parse_headers(Rest0),
Rest1
end,
RestSize = byte_size(Rest),
<<Rest:RestSize/binary, Expect/bits>> = Body,
raw_expect_recv(Client, Expect).
chunked_split_delay_in_chunk_crlf(Config) ->
doc("Confirm that chunked transfer-encoding works when "
"the body is received with a delay inside the chunks end CRLF."),
Body = list_to_binary(io_lib:format("~p", [lists:seq(1, 100)])),
Chunks = do_chunked_body(50, Body, []),
Client = raw_open(Config),
ok = raw_send(Client,
"POST /echo/read_body HTTP/1.1\r\n"
"Host: localhost\r\n"
"Transfer-encoding: chunked\r\n\r\n"),
_ = [begin
Len = byte_size(Chunk) - (rand:uniform(2) - 1),
<<Begin:Len/binary, End/binary>> = Chunk,
raw_send(Client, Begin),
timer:sleep(10),
raw_send(Client, End)
end || Chunk <- Chunks],
Rest = case catch raw_recv_head(Client) of
{'EXIT', _} -> error(closed);
Data ->
{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
{_, Rest1} = cow_http:parse_headers(Rest0),
Rest1
end,
RestSize = byte_size(Rest),
<<Rest:RestSize/binary, Expect/bits>> = Body,
raw_expect_recv(Client, Expect).
do_chunked_body(_, <<>>, Acc) ->
lists:reverse([cow_http_te:last_chunk()|Acc]);
do_chunked_body(ChunkSize0, Data, Acc) ->
ChunkSize = min(byte_size(Data), ChunkSize0),
<<Chunk:ChunkSize/binary, Rest/binary>> = Data,
do_chunked_body(ChunkSize, Rest,
[iolist_to_binary(cow_http_te:chunk(Chunk))|Acc]).
http10_keepalive_false(Config) ->
doc("Confirm the option http10_keepalive => false disables keep-alive "
"completely for HTTP/1.0 connections."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
http10_keepalive => false
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
Keepalive = "GET / HTTP/1.0\r\nhost: localhost\r\nConnection: keep-alive\r\n\r\n",
Client = raw_open([{type, tcp}, {port, Port}, {opts, []}|Config]),
ok = raw_send(Client, Keepalive),
_ = case catch raw_recv_head(Client) of
{'EXIT', _} -> error(closed);
Data ->
%% Cowboy always advertises itself as HTTP/1.1.
{'HTTP/1.1', 200, _, Rest} = cow_http:parse_status_line(Data),
{Headers, _} = cow_http:parse_headers(Rest),
{_, <<"close">>} = lists:keyfind(<<"connection">>, 1, Headers)
end,
ok = raw_send(Client, Keepalive),
case catch raw_recv_head(Client) of
{'EXIT', _} -> closed;
_ -> error(not_closed)
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
idle_timeout_read_body(Config) ->
doc("Ensure the idle_timeout drops connections when the "
"connection is idle too long reading the request body."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
request_timeout => 60000,
idle_timeout => 500
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
_StreamRef = gun:post(ConnPid, "/echo/read_body",
#{<<"content-length">> => <<"12">>}),
{error, {down, {shutdown, closed}}} = gun:await(ConnPid, undefined, 1000)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
idle_timeout_read_body_pipeline(Config) ->
doc("Ensure the idle_timeout drops connections when the "
"connection is idle too long reading the request body."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
request_timeout => 60000,
idle_timeout => 500
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
StreamRef1 = gun:get(ConnPid, "/"),
StreamRef2 = gun:get(ConnPid, "/"),
_StreamRef3 = gun:post(ConnPid, "/echo/read_body",
#{<<"content-length">> => <<"12">>}),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef1),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef2),
{error, {down, {shutdown, closed}}} = gun:await(ConnPid, undefined, 1000)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
idle_timeout_skip_body(Config) ->
doc("Ensure the idle_timeout drops connections when the "
"connection is idle too long skipping the request body."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
request_timeout => 60000,
idle_timeout => 500
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
StreamRef = gun:post(ConnPid, "/",
#{<<"content-length">> => <<"12">>}),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef),
{error, {down, {shutdown, closed}}} = gun:await(ConnPid, undefined, 1000)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
idle_timeout_infinity(Config) ->
doc("Ensure the idle_timeout option accepts the infinity value."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
idle_timeout => infinity
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
timer:sleep(500),
#{socket := Socket} = gun:info(ConnPid),
Pid = get_remote_pid_tcp(Socket),
_ = gun:post(ConnPid, "/echo/read_body",
[{<<"content-type">>, <<"text/plain">>}]),
Ref = erlang:monitor(process, Pid),
receive
{'DOWN', Ref, process, Pid, Reason} ->
error(Reason)
after 1000 ->
gun:close(ConnPid)
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
idle_timeout_on_send(Config) ->
doc("Ensure the idle timeout is not reset when sending (by default)."),
do_idle_timeout_on_send(Config, http).
%% Also used by http2_SUITE.
do_idle_timeout_on_send(Config, Protocol) ->
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
idle_timeout => 1000
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, Protocol}, {port, Port}|Config]),
{ok, Protocol} = gun:await_up(ConnPid),
timer:sleep(500),
#{socket := Socket} = gun:info(ConnPid),
Pid = get_remote_pid_tcp(Socket),
StreamRef = gun:get(ConnPid, "/streamed_result/10/250"),
Ref = erlang:monitor(process, Pid),
receive
{gun_response, ConnPid, StreamRef, nofin, _Status, _Headers} ->
do_idle_timeout_recv_loop(Ref, Pid, ConnPid, StreamRef, false)
after 2000 ->
error(timeout)
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
idle_timeout_reset_on_send(Config) ->
doc("Ensure the reset_idle_timeout_on_send results in the "
"idle timeout resetting when sending ."),
do_idle_timeout_reset_on_send(Config, http).
%% Also used by http2_SUITE.
do_idle_timeout_reset_on_send(Config, Protocol) ->
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
idle_timeout => 1000,
reset_idle_timeout_on_send => true
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, Protocol}, {port, Port}|Config]),
{ok, Protocol} = gun:await_up(ConnPid),
timer:sleep(500),
#{socket := Socket} = gun:info(ConnPid),
Pid = get_remote_pid_tcp(Socket),
StreamRef = gun:get(ConnPid, "/streamed_result/10/250"),
Ref = erlang:monitor(process, Pid),
receive
{gun_response, ConnPid, StreamRef, nofin, _Status, _Headers} ->
do_idle_timeout_recv_loop(Ref, Pid, ConnPid, StreamRef, true)
after 2000 ->
error(timeout)
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
do_idle_timeout_recv_loop(Ref, Pid, ConnPid, StreamRef, ExpectCompletion) ->
receive
{gun_data, ConnPid, StreamRef, nofin, _Data} ->
do_idle_timeout_recv_loop(Ref, Pid, ConnPid, StreamRef, ExpectCompletion);
{gun_data, ConnPid, StreamRef, fin, _Data} when ExpectCompletion ->
gun:close(ConnPid);
{gun_data, ConnPid, StreamRef, fin, _Data} ->
gun:close(ConnPid),
error(completed);
{'DOWN', Ref, process, Pid, _} when ExpectCompletion ->
gun:close(ConnPid),
error(exited);
{'DOWN', Ref, process, Pid, _} ->
ok
after 2000 ->
error(timeout)
end.
persistent_term_router(Config) ->
doc("The router can retrieve the routes from persistent_term storage."),
case erlang:function_exported(persistent_term, get, 1) of
true -> do_persistent_term_router(Config);
false -> {skip, "This test uses the persistent_term functionality added in Erlang/OTP 21.2."}
end.
do_persistent_term_router(Config) ->
persistent_term:put(?FUNCTION_NAME, init_dispatch(Config)),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => {persistent_term, ?FUNCTION_NAME}}
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
StreamRef = gun:get(ConnPid, "/"),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef),
gun:close(ConnPid)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
request_timeout(Config) ->
doc("Ensure the request_timeout drops connections when requests "
"fail to come in fast enough."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
request_timeout => 500
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
{error, {down, {shutdown, closed}}} = gun:await(ConnPid, undefined, 1000)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
request_timeout_pipeline(Config) ->
doc("Ensure the request_timeout drops connections when requests "
"fail to come in fast enough after pipelined requests went through."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
request_timeout => 500
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
StreamRef1 = gun:get(ConnPid, "/"),
StreamRef2 = gun:get(ConnPid, "/"),
StreamRef3 = gun:get(ConnPid, "/"),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef1),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef2),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef3),
{error, {down, {shutdown, closed}}} = gun:await(ConnPid, undefined, 1000)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
request_timeout_pipeline_delay(Config) ->
doc("Ensure the request_timeout does not trigger on requests "
"coming in after a large request body."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
request_timeout => 500
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
StreamRef1 = gun:post(ConnPid, "/", #{}, <<0:8000000>>),
StreamRef2 = gun:get(ConnPid, "/delay_hello"),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef1),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef2),
{error, {down, {shutdown, closed}}} = gun:await(ConnPid, undefined, 1000)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
request_timeout_skip_body(Config) ->
doc("Ensure the request_timeout drops connections when requests "
"fail to come in fast enough after skipping a request body."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
request_timeout => 500
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
Client = raw_open([{type, tcp}, {port, Port}, {opts, []}|Config]),
ok = raw_send(Client, <<
"POST / HTTP/1.1\r\n"
"host: localhost\r\n"
"content-length: 12\r\n\r\n"
>>),
Data = raw_recv_head(Client),
{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
{Headers, Rest} = cow_http:parse_headers(Rest0),
{_, Len} = lists:keyfind(<<"content-length">>, 1, Headers),
<<"Hello world!">> = raw_recv_rest(Client, binary_to_integer(Len), Rest),
%% We then send the request data that should be skipped by Cowboy.
timer:sleep(100),
raw_send(Client, <<"Hello world!">>),
%% Connection should be closed by the request_timeout after that.
{error, closed} = raw_recv(Client, 1, 1000)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
request_timeout_skip_body_more(Config) ->
doc("Ensure the request_timeout drops connections when requests "
"fail to come in fast enough after skipping a request body."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
request_timeout => 500
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
Client = raw_open([{type, tcp}, {port, Port}, {opts, []}|Config]),
ok = raw_send(Client, <<
"POST / HTTP/1.1\r\n"
"host: localhost\r\n"
"content-length: 12\r\n\r\n"
>>),
Data = raw_recv_head(Client),
{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
{Headers, Rest} = cow_http:parse_headers(Rest0),
{_, Len} = lists:keyfind(<<"content-length">>, 1, Headers),
<<"Hello world!">> = raw_recv_rest(Client, binary_to_integer(Len), Rest),
%% We then send the request data that should be skipped by Cowboy.
timer:sleep(100),
raw_send(Client, <<"Hello world!">>),
%% Send the start of another request.
ok = raw_send(Client, <<
"GET / HTTP/1.1\r\n"
"host: localhost\r\n"
%% Missing final \r\n on purpose.
>>),
%% Connection should be closed by the request_timeout after that.
%% We attempt to send a 408 response on a best effort basis so
%% that is accepted as well.
case raw_recv(Client, 13, 1000) of
{error, closed} -> ok;
{ok, <<"HTTP/1.1 408 ", _/bits>>} -> ok
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
request_timeout_infinity(Config) ->
doc("Ensure the request_timeout option accepts the infinity value."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
request_timeout => infinity
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
timer:sleep(500),
#{socket := Socket} = gun:info(ConnPid),
Pid = get_remote_pid_tcp(Socket),
Ref = erlang:monitor(process, Pid),
receive
{'DOWN', Ref, process, Pid, Reason} ->
error(Reason)
after 1000 ->
gun:close(ConnPid)
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
set_options_chunked_false(Config) ->
doc("Confirm the option chunked can be dynamically set to disable "
"chunked transfer-encoding. This results in the closing of the "
"connection after the current request."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
chunked => true
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
Request = "GET /set_options/chunked_false HTTP/1.1\r\nhost: localhost\r\n\r\n",
Client = raw_open([{type, tcp}, {port, Port}, {opts, []}|Config]),
ok = raw_send(Client, Request),
Rest = case catch raw_recv_head(Client) of
{'EXIT', _} -> error(closed);
Data ->
%% Cowboy always advertises itself as HTTP/1.1.
{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
{Headers, Rest1} = cow_http:parse_headers(Rest0),
false = lists:keyfind(<<"content-length">>, 1, Headers),
false = lists:keyfind(<<"transfer-encoding">>, 1, Headers),
Rest1
end,
Bits = 8000000 - bit_size(Rest),
raw_expect_recv(Client, <<0:Bits>>),
{error, closed} = raw_recv(Client, 1, 1000)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
set_options_chunked_false_ignored(Config) ->
doc("Confirm the option chunked can be dynamically set to disable "
"chunked transfer-encoding, and that it is ignored if the "
"response is not streamed."),
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
chunked => true
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
%% We do a first request setting the option but not
%% using chunked transfer-encoding in the response.
StreamRef1 = gun:get(ConnPid, "/set_options/chunked_false_ignored"),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef1),
{ok, <<"Hello world!">>} = gun:await_body(ConnPid, StreamRef1),
%% We then do a second request to confirm that chunked
%% is not disabled for that second request.
StreamRef2 = gun:get(ConnPid, "/resp/stream_reply2/200"),
{response, nofin, 200, Headers} = gun:await(ConnPid, StreamRef2),
{_, <<"chunked">>} = lists:keyfind(<<"transfer-encoding">>, 1, Headers),
gun:close(ConnPid)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
set_options_idle_timeout(Config) ->
doc("Confirm that the idle_timeout option can be dynamically "
"set to change how long Cowboy will wait before it closes the connection."),
%% We start with a long timeout and then cut it short.
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
idle_timeout => 60000
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
timer:sleep(500),
#{socket := Socket} = gun:info(ConnPid),
Pid = get_remote_pid_tcp(Socket),
_ = gun:post(ConnPid, "/set_options/idle_timeout_short",
[{<<"content-type">>, <<"text/plain">>}]),
Ref = erlang:monitor(process, Pid),
receive
{'DOWN', Ref, process, Pid, _} ->
ok
after 2000 ->
error(timeout)
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
set_options_idle_timeout_only_applies_to_current_request(Config) ->
doc("Confirm that changes to the idle_timeout option only apply to the current stream."),
%% We start with a long timeout and then cut it short.
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], #{
env => #{dispatch => init_dispatch(Config)},
idle_timeout => 500
}),
Port = ranch:get_port(?FUNCTION_NAME),
try
ConnPid = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
{ok, http} = gun:await_up(ConnPid),
timer:sleep(500),
#{socket := Socket} = gun:info(ConnPid),
Pid = get_remote_pid_tcp(Socket),
StreamRef = gun:post(ConnPid, "/set_options/idle_timeout_long",
[{<<"content-type">>, <<"text/plain">>}]),
Ref = erlang:monitor(process, Pid),
receive
{'DOWN', Ref, process, Pid, Reason} ->
error(Reason)
after 2000 ->
ok
end,
%% Finish the first request and start a second one to confirm
%% the idle_timeout option is back to normal.
gun:data(ConnPid, StreamRef, fin, <<"Hello!">>),
{response, nofin, 200, _} = gun:await(ConnPid, StreamRef),
{ok, <<"Hello!">>} = gun:await_body(ConnPid, StreamRef),
_ = gun:post(ConnPid, "/echo/read_body",
[{<<"content-type">>, <<"text/plain">>}]),
receive
{'DOWN', Ref, process, Pid, _} ->
ok
after 2000 ->
error(timeout)
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
switch_protocol_flush(Config) ->
doc("Confirm that switch_protocol does not flush unrelated messages."),
ProtoOpts = #{
env => #{dispatch => init_dispatch(Config)},
stream_handlers => [switch_protocol_flush_h]
},
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], ProtoOpts),
Port = ranch:get_port(?FUNCTION_NAME),
try
Self = self(),
ConnPid = gun_open([{port, Port}, {type, tcp}, {protocol, http}|Config]),
_ = gun:get(ConnPid, "/", [
{<<"x-test-pid">>, pid_to_list(Self)}
]),
receive
{Self, Events} ->
switch_protocol_flush_h:validate(Events)
after 5000 ->
error(timeout)
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
graceful_shutdown_connection(Config) ->
doc("Check that the current request is handled before gracefully "
"shutting down a connection."),
Dispatch = cowboy_router:compile([{"localhost", [
{"/hello", delay_hello_h,
#{delay => 0, notify_received => self()}},
{"/delay_hello", delay_hello_h,
#{delay => 1000, notify_received => self()}}
]}]),
ProtoOpts = #{
env => #{dispatch => Dispatch}
},
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, [{port, 0}], ProtoOpts),
Port = ranch:get_port(?FUNCTION_NAME),
try
Client = raw_open([{type, tcp}, {port, Port}, {opts, []}|Config]),
ok = raw_send(Client,
"GET /delay_hello HTTP/1.1\r\n"
"Host: localhost\r\n\r\n"
"GET /hello HTTP/1.1\r\n"
"Host: localhost\r\n\r\n"),
receive {request_received, <<"/delay_hello">>} -> ok end,
receive {request_received, <<"/hello">>} -> ok end,
CowboyConnPid = get_remote_pid_tcp(element(2, Client)),
CowboyConnRef = erlang:monitor(process, CowboyConnPid),
ok = sys:terminate(CowboyConnPid, system_is_going_down),
Rest = case catch raw_recv_head(Client) of
{'EXIT', _} -> error(closed);
Data ->
{'HTTP/1.1', 200, _, Rest0} = cow_http:parse_status_line(Data),
{Headers, Rest1} = cow_http:parse_headers(Rest0),
<<"close">> = proplists:get_value(<<"connection">>, Headers),
Rest1
end,
<<"Hello world!">> = raw_recv_rest(Client, byte_size(<<"Hello world!">>), Rest),
{error, closed} = raw_recv(Client, 0, 1000),
receive
{'DOWN', CowboyConnRef, process, CowboyConnPid, _Reason} ->
ok
end
after
cowboy:stop_listener(?FUNCTION_NAME)
end.
graceful_shutdown_listener(Config) ->
doc("Check that connections are shut down gracefully when stopping a listener."),
TransOpts = #{
socket_opts => [{port, 0}],
shutdown => 1000 %% Shorter timeout to make the test case faster.
},
Dispatch = cowboy_router:compile([{"localhost", [
{"/delay_hello", delay_hello_h,
#{delay => 500, notify_received => self()}},
{"/long_delay_hello", delay_hello_h,
#{delay => 10000, notify_received => self()}}
]}]),
ProtoOpts = #{
env => #{dispatch => Dispatch}
},
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, TransOpts, ProtoOpts),
Port = ranch:get_port(?FUNCTION_NAME),
ConnPid1 = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
Ref1 = gun:get(ConnPid1, "/delay_hello"),
ConnPid2 = gun_open([{type, tcp}, {protocol, http}, {port, Port}|Config]),
Ref2 = gun:get(ConnPid2, "/long_delay_hello"),
%% Shutdown listener while the handlers are working.
receive {request_received, <<"/delay_hello">>} -> ok end,
receive {request_received, <<"/long_delay_hello">>} -> ok end,
%% Note: This call does not complete quickly and will
%% prevent other cowboy:stop_listener/1 calls to complete.
ok = cowboy:stop_listener(?FUNCTION_NAME),
%% Check that the 1st request is handled before shutting down.
{response, nofin, 200, RespHeaders} = gun:await(ConnPid1, Ref1),
<<"close">> = proplists:get_value(<<"connection">>, RespHeaders),
{ok, RespBody} = gun:await_body(ConnPid1, Ref1),
<<"Hello world!">> = iolist_to_binary(RespBody),
gun:close(ConnPid1),
%% Check that the 2nd (very slow) request is not handled.
{error, {stream_error, closed}} = gun:await(ConnPid2, Ref2),
gun:close(ConnPid2).
send_timeout_close(_Config) ->
doc("Check that connections are closed on send timeout."),
TransOpts = #{
socket_opts => [
{port, 0},
{send_timeout, 100},
{send_timeout_close, true},
{sndbuf, 10}
]
},
Dispatch = cowboy_router:compile([{"localhost", [
{"/endless", loop_handler_endless_h, #{delay => 100}}
]}]),
ProtoOpts = #{
env => #{dispatch => Dispatch},
idle_timeout => infinity
},
{ok, _} = cowboy:start_clear(?FUNCTION_NAME, TransOpts, ProtoOpts),
Port = ranch:get_port(?FUNCTION_NAME),
try
%% Connect a client that sends a request and waits indefinitely.
{ok, ClientSocket} = gen_tcp:connect("localhost", Port,
[{recbuf, 10}, {buffer, 10}, {active, false}, {packet, 0}]),
ok = gen_tcp:send(ClientSocket, [
"GET /endless HTTP/1.1\r\n",
"Host: localhost:", integer_to_list(Port), "\r\n",
"x-test-pid: ", pid_to_list(self()), "\r\n\r\n"
]),
%% Wait for the handler to start then get its pid,
%% the remote connection's pid and socket.
StreamPid = receive
{Self, StreamPid0, init} when Self =:= self() ->
StreamPid0
after 1000 ->
error(timeout)
end,
ServerPid = ct_helper:get_remote_pid_tcp(ClientSocket),
{links, ServerLinks} = process_info(ServerPid, links),
[ServerSocket] = [PidOrPort || PidOrPort <- ServerLinks, is_port(PidOrPort)],
%% Poll the socket repeatedly until it is closed by the server.
WaitClosedFun =
fun F(T) when T =< 0 ->
error({status, prim_inet:getstatus(ServerSocket)});
F(T) ->
Snooze = 100,
case inet:sockname(ServerSocket) of
{error, _} ->
timer:sleep(Snooze);
{ok, _} ->
timer:sleep(Snooze),
F(T - Snooze)
end
end,
ok = WaitClosedFun(2000),
false = erlang:is_process_alive(StreamPid),
false = erlang:is_process_alive(ServerPid)
after
cowboy:stop_listener(?FUNCTION_NAME)
end.