Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

return allow header #1633

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

return allow header #1633

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6b14cd6
return allow header
geeksilva97 Feb 3, 2024
3df6822
add function to compute allow header content from list
geeksilva97 Feb 4, 2024
1288e68
add allowd_methods tests
geeksilva97 Feb 4, 2024
ec6fc7d
removed unused case from allowed_methods callback
geeksilva97 Feb 4, 2024
c37a6fb
minor refactor
geeksilva97 Feb 4, 2024
c804ca4
remove header setting from options/2
geeksilva97 Feb 6, 2024
eded22d
unify case clauses
geeksilva97 Feb 6, 2024
3bc7b08
handle empty list when parsing allowed methods
geeksilva97 Feb 6, 2024
4100228
remove header setting from method_not_allowed
geeksilva97 Feb 6, 2024
1409693
remove unused entry from record
geeksilva97 Feb 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
52 changes: 24 additions & 28 deletions src/cowboy_rest.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,41 +324,43 @@ known_methods(Req, State=#state{method=Method}) ->
uri_too_long(Req, State) ->
expect(Req, State, uri_too_long, false, fun allowed_methods/2, 414).

stringify_allowed_methods(MethodList) when is_list(MethodList) ->
case MethodList of
[] -> <<>>;
_ ->
<< ", ", Allow/binary >> = << << ", ", M/binary >> || M <- MethodList >>,
Allow
end.
geeksilva97 marked this conversation as resolved.
Show resolved Hide resolved

%% allowed_methods/2 should return a list of binary methods.
allowed_methods(Req, State=#state{method=Method}) ->
DefaultAllowedMethods = [<<"HEAD">>, <<"GET">>, <<"OPTIONS">>],
case call(Req, State, allowed_methods) of
no_call when Method =:= <<"HEAD">>; Method =:= <<"GET">> ->
next(Req, State, fun malformed_request/2);
no_call when Method =:= <<"OPTIONS">> ->
next(Req, State#state{allowed_methods=
[<<"HEAD">>, <<"GET">>, <<"OPTIONS">>]},
fun malformed_request/2);
no_call when Method =:= <<"HEAD">>; Method =:= <<"GET">>; Method =:= <<"OPTIONS">> ->
Allow = stringify_allowed_methods(DefaultAllowedMethods),
Req2 = cowboy_req:set_resp_header(<<"allow">>, Allow, Req),
next(Req2, State, fun malformed_request/2);
no_call ->
method_not_allowed(Req, State,
[<<"HEAD">>, <<"GET">>, <<"OPTIONS">>]);
Allow = stringify_allowed_methods(DefaultAllowedMethods),
Req2 = cowboy_req:set_resp_header(<<"allow">>, Allow, Req),
method_not_allowed(Req2, State);
{stop, Req2, State2} ->
terminate(Req2, State2);
{Switch, Req2, State2} when element(1, Switch) =:= switch_handler ->
switch_handler(Switch, Req2, State2);
{List, Req2, State2} ->
Allow = stringify_allowed_methods(List),
Req3 = cowboy_req:set_resp_header(<<"allow">>, Allow, Req2),
case lists:member(Method, List) of
true when Method =:= <<"OPTIONS">> ->
next(Req2, State2#state{allowed_methods=List},
fun malformed_request/2);
true ->
next(Req2, State2, fun malformed_request/2);
next(Req3, State2, fun malformed_request/2);
false ->
method_not_allowed(Req2, State2, List)
method_not_allowed(Req3, State2)
end
end.

method_not_allowed(Req, State, []) ->
Req2 = cowboy_req:set_resp_header(<<"allow">>, <<>>, Req),
respond(Req2, State, 405);
method_not_allowed(Req, State, Methods) ->
<< ", ", Allow/binary >> = << << ", ", M/binary >> || M <- Methods >>,
Req2 = cowboy_req:set_resp_header(<<"allow">>, Allow, Req),
respond(Req2, State, 405).
method_not_allowed(Req, State) ->
respond(Req, State, 405).

malformed_request(Req, State) ->
expect(Req, State, malformed_request, false, fun is_authorized/2, 400).
Expand Down Expand Up @@ -413,16 +415,10 @@ valid_entity_length(Req, State) ->

%% If you need to add additional headers to the response at this point,
%% you should do it directly in the options/2 call using set_resp_headers.
options(Req, State=#state{allowed_methods=Methods, method= <<"OPTIONS">>}) ->
geeksilva97 marked this conversation as resolved.
Show resolved Hide resolved
options(Req, State=#state{method= <<"OPTIONS">>}) ->
case call(Req, State, options) of
no_call when Methods =:= [] ->
Req2 = cowboy_req:set_resp_header(<<"allow">>, <<>>, Req),
respond(Req2, State, 200);
no_call ->
<< ", ", Allow/binary >>
= << << ", ", M/binary >> || M <- Methods >>,
Req2 = cowboy_req:set_resp_header(<<"allow">>, Allow, Req),
respond(Req2, State, 200);
respond(Req, State, 200);
{stop, Req2, State2} ->
terminate(Req2, State2);
{Switch, Req2, State2} when element(1, Switch) =:= switch_handler ->
Expand Down
19 changes: 17 additions & 2 deletions test/rest_handler_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,8 @@ delete_resource_missing(Config) ->
Ref = gun:delete(ConnPid, "/delete_resource?missing", [
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, _, 500, _} = gun:await(ConnPid, Ref),
{response, _, 500, Headers} = gun:await(ConnPid, Ref),
{_, <<"DELETE">>} = lists:keyfind(<<"allow">>, 1, Headers),
ok.

create_resource_created(Config) ->
Expand All @@ -483,7 +484,8 @@ create_resource_created(Config) ->
Ref = gun:post(ConnPid, "/create_resource?created", [
{<<"content-type">>, <<"application/text">>}
], <<"hello">>, #{}),
{response, _, 201, _} = gun:await(ConnPid, Ref),
{response, _, 201, Headers} = gun:await(ConnPid, Ref),
{_, <<"POST">>} = lists:keyfind(<<"allow">>, 1, Headers),
geeksilva97 marked this conversation as resolved.
Show resolved Hide resolved
ok.

create_resource_see_other(Config) ->
Expand All @@ -496,6 +498,7 @@ create_resource_see_other(Config) ->
], <<"hello">>, #{}),
{response, _, 303, RespHeaders} = gun:await(ConnPid, Ref),
{_, _} = lists:keyfind(<<"location">>, 1, RespHeaders),
{_, <<"POST">>} = lists:keyfind(<<"allow">>, 1, RespHeaders),
ok.

error_on_malformed_accept(Config) ->
Expand Down Expand Up @@ -778,6 +781,17 @@ last_modified_missing(Config) ->
false = lists:keyfind(<<"last-modified">>, 1, Headers),
ok.

head_call(Config) ->
doc("A successful HEAD request to a simple handler results in "
"a 200 OK response with the allow header set. (RFC7231 4.3.7)"),
ConnPid = gun_open(Config),
Ref = gun:head(ConnPid, "/", [
{<<"accept-encoding">>, <<"gzip">>}
]),
{response, fin, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"HEAD, GET, OPTIONS">>} = lists:keyfind(<<"allow">>, 1, Headers),
ok.

options_missing(Config) ->
doc("A successful OPTIONS request to a simple handler results in "
"a 200 OK response with the allow header set. (RFC7231 4.3.7)"),
Expand All @@ -799,6 +813,7 @@ provide_callback(Config) ->
]),
{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
{_, <<"text/plain">>} = lists:keyfind(<<"content-type">>, 1, Headers),
{_, <<"HEAD, GET, OPTIONS">>} = lists:keyfind(<<"allow">>, 1, Headers),
{ok, <<"This is REST!">>} = gun:await_body(ConnPid, Ref),
ok.

Expand Down