Add {switch_handler, Module} return value to cowboy_rest

Also {switch_handler, Module, Opts}.

Allows switching to a different handler type. This is
particularly useful for processing most of the request
with cowboy_rest and then streaming the response body
using cowboy_loop.

2 files changed, 106 insertions, 0 deletions

diff --git a/test/handlers/switch_handler_h.erl b/test/handlers/switch_handler_h.erl
new file mode 100644
index 0000000..f1580d1
--- /dev/null
+++ b/test/handlers/switch_handler_h.erl
@@ -0,0 +1,36 @@
+-module(switch_handler_h).
+
+-export([init/2]).
+-export([content_types_provided/2]).
+-export([provide/2]).
+-export([info/3]).
+
+init(Req, State) ->
+	{cowboy_rest, Req, State}.
+
+content_types_provided(Req, State) ->
+	{[{<<"text/plain">>, provide}], Req, State}.
+
+provide(Req0, run) ->
+	Req = cowboy_req:stream_reply(200, Req0),
+	send_after(0),
+	{{switch_handler, cowboy_loop}, Req, 0};
+provide(Req0, hibernate) ->
+	Req = cowboy_req:stream_reply(200, Req0),
+	send_after(0),
+	{{switch_handler, cowboy_loop, hibernate}, Req, 0}.
+
+send_after(N) ->
+	erlang:send_after(100, self(), {stream, msg(N)}).
+
+msg(0) -> <<"Hello\n">>;
+msg(1) -> <<"streamed\n">>;
+msg(2) -> <<"world!\n">>;
+msg(3) -> stop.
+
+info({stream, stop}, Req, State) ->
+	{stop, Req, State};
+info({stream, What}, Req, State) ->
+	cowboy_req:stream_body(What, nofin, Req),
+	send_after(State + 1),
+	{ok, Req, State + 1}.
diff --git a/test/rest_handler_SUITE.erl b/test/rest_handler_SUITE.erl
new file mode 100644
index 0000000..d48690b
--- /dev/null
+++ b/test/rest_handler_SUITE.erl
@@ -0,0 +1,70 @@
+%% Copyright (c) 2017, Loïc Hoguin <[email protected]>
+%%
+%% 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(rest_handler_SUITE).
+-compile(export_all).
+
+-import(ct_helper, [config/2]).
+-import(ct_helper, [doc/1]).
+-import(cowboy_test, [gun_open/1]).
+
+%% ct.
+
+all() ->
+	cowboy_test:common_all().
+
+groups() ->
+	cowboy_test:common_groups(ct_helper:all(?MODULE)).
+
+init_per_group(Name, Config) ->
+	cowboy_test:init_common_groups(Name, Config, ?MODULE).
+
+end_per_group(Name, _) ->
+	cowboy:stop_listener(Name).
+
+%% Dispatch configuration.
+
+init_dispatch(_) ->
+	cowboy_router:compile([{'_', [
+		{"/switch_handler", switch_handler_h, run},
+		{"/switch_handler_opts", switch_handler_h, hibernate}
+	]}]).
+
+%% Internal.
+
+do_decode(Headers, Body) ->
+	case lists:keyfind(<<"content-encoding">>, 1, Headers) of
+		{_, <<"gzip">>} -> zlib:gunzip(Body);
+		_ -> Body
+	end.
+
+%% Tests.
+
+switch_handler(Config) ->
+	doc("Switch REST to loop handler for streaming the response body."),
+	ConnPid = gun_open(Config),
+	Ref = gun:get(ConnPid, "/switch_handler", [{<<"accept-encoding">>, <<"gzip">>}]),
+	{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
+	{ok, Body} = gun:await_body(ConnPid, Ref),
+	<<"Hello\nstreamed\nworld!\n">> = do_decode(Headers, Body),
+	ok.
+
+switch_handler_opts(Config) ->
+	doc("Switch REST to loop handler for streaming the response body; with options."),
+	ConnPid = gun_open(Config),
+	Ref = gun:get(ConnPid, "/switch_handler_opts", [{<<"accept-encoding">>, <<"gzip">>}]),
+	{response, nofin, 200, Headers} = gun:await(ConnPid, Ref),
+	{ok, Body} = gun:await_body(ConnPid, Ref),
+	<<"Hello\nstreamed\nworld!\n">> = do_decode(Headers, Body),
+	ok.