Allow passing options to sub protocols

Before this commit we had an issue where configuring a
Websocket connection was simply not possible without
doing magic, adding callbacks or extra return values.
The init/2 function only allowed setting hibernate
and timeout options.

After this commit, when switching to a different
type of handler you can either return

  {module, Req, State}

or

  {module, Req, State, Opts}

where Opts is any value (as far as the sub protocol
interface is concerned) and is ultimately checked
by the custom handlers.

A large protocol like Websocket would accept only
a map there, with many different options, while a
small interface like loop handlers would allow
passing hibernate and nothing else.

For Websocket, hibernate must be set from the
websocket_init/1 callback, because init/2 executes
in a separate process.

Sub protocols now have two callbacks: one with the
Opts value, one without.

The loop handler code was largely reworked and
simplified. It does not need to manage a timeout
or read from the socket anymore, it's the job of
the protocol code. A lot of unnecessary stuff was
therefore removed.

Websocket compression must now be enabled from
the handler options instead of per listener. This
means that a project can have two separate Websocket
handlers with different options. Compression is
still disabled by default, and the idle_timeout
value was changed from inifnity to 60000 (60 seconds),
as that's safer and is also a good value for mobile
devices.

9 files changed, 22 insertions, 12 deletions

diff --git a/test/handlers/long_polling_h.erl b/test/handlers/long_polling_h.erl
index 17afa0a..3dd0f77 100644
--- a/test/handlers/long_polling_h.erl
+++ b/test/handlers/long_polling_h.erl
@@ -11,7 +11,7 @@
 
 init(Req, _) ->
 	erlang:send_after(200, self(), timeout),
-	{cowboy_loop, Req, 2, 5000, hibernate}.
+	{cowboy_loop, Req, 2, hibernate}.
 
 info(timeout, Req, 0) ->
 	%% @todo Why 102?
diff --git a/test/handlers/loop_handler_body_h.erl b/test/handlers/loop_handler_body_h.erl
index e0ea41b..cadb2d9 100644
--- a/test/handlers/loop_handler_body_h.erl
+++ b/test/handlers/loop_handler_body_h.erl
@@ -11,7 +11,7 @@
 
 init(Req, _) ->
 	self() ! timeout,
-	{cowboy_loop, Req, undefined, 5000, hibernate}.
+	{cowboy_loop, Req, undefined, hibernate}.
 
 info(timeout, Req0, State) ->
 	{ok, Body, Req} = cowboy_req:read_body(Req0),
diff --git a/test/handlers/loop_handler_timeout_h.erl b/test/handlers/loop_handler_timeout_h.erl
index 6502a3a..1628074 100644
--- a/test/handlers/loop_handler_timeout_h.erl
+++ b/test/handlers/loop_handler_timeout_h.erl
@@ -12,7 +12,7 @@
 
 init(Req, _) ->
 	erlang:send_after(1000, self(), timeout),
-	{cowboy_loop, Req, undefined, 200, hibernate}.
+	{cowboy_loop, Req, undefined, hibernate}.
 
 info(timeout, Req, State) ->
 	{stop, cowboy_req:reply(500, Req), State}.
diff --git a/test/http_SUITE_data/http_loop_stream_recv.erl b/test/http_SUITE_data/http_loop_stream_recv.erl
index 18b3d29..8c6f6b0 100644
--- a/test/http_SUITE_data/http_loop_stream_recv.erl
+++ b/test/http_SUITE_data/http_loop_stream_recv.erl
@@ -9,7 +9,7 @@
 init(Req, _) ->
 	receive after 100 -> ok end,
 	self() ! stream,
-	{cowboy_loop, Req, undefined, 100}.
+	{cowboy_loop, Req, undefined}.
 
 info(stream, Req, undefined) ->
 	stream(Req, 1, <<>>).
diff --git a/test/ws_SUITE.erl b/test/ws_SUITE.erl
index 9f5cb0a..38c145e 100644
--- a/test/ws_SUITE.erl
+++ b/test/ws_SUITE.erl
@@ -39,15 +39,13 @@ init_per_group(Name = autobahn, Config) ->
 			{skip, "Autobahn Test Suite not installed."};
 		_ ->
 			{ok, _} = cowboy:start_clear(Name, 100, [{port, 33080}], #{
-				env => #{dispatch => init_dispatch()},
-				websocket_compress => true
+				env => #{dispatch => init_dispatch()}
 			}),
 			Config
 	end;
 init_per_group(Name = ws, Config) ->
 	cowboy_test:init_http(Name, #{
-		env => #{dispatch => init_dispatch()},
-		websocket_compress => true
+		env => #{dispatch => init_dispatch()}
 	}, Config).
 
 end_per_group(Listener, _Config) ->
diff --git a/test/ws_SUITE_data/ws_echo.erl b/test/ws_SUITE_data/ws_echo.erl
index 4b832df..a94b4c0 100644
--- a/test/ws_SUITE_data/ws_echo.erl
+++ b/test/ws_SUITE_data/ws_echo.erl
@@ -7,7 +7,9 @@
 -export([websocket_info/2]).
 
 init(Req, _) ->
-	{cowboy_websocket, Req, undefined}.
+	{cowboy_websocket, Req, undefined, #{
+		compress => true
+	}}.
 
 websocket_handle({text, Data}, State) ->
 	{reply, {text, Data}, State};
diff --git a/test/ws_SUITE_data/ws_subprotocol.erl b/test/ws_SUITE_data/ws_subprotocol.erl
index 3079bc6..1c9aefc 100644
--- a/test/ws_SUITE_data/ws_subprotocol.erl
+++ b/test/ws_SUITE_data/ws_subprotocol.erl
@@ -9,7 +9,9 @@
 init(Req, Opts) ->
 	[Protocol | _] = cowboy_req:parse_header(<<"sec-websocket-protocol">>, Req),
 	Req2 = cowboy_req:set_resp_header(<<"sec-websocket-protocol">>, Protocol, Req),
-	{cowboy_websocket, Req2, Opts, 1000}.
+	{cowboy_websocket, Req2, Opts, #{
+		idle_timeout => 1000
+	}}.
 
 websocket_handle(_Frame, State) ->
 	{ok, State}.
diff --git a/test/ws_SUITE_data/ws_timeout_cancel.erl b/test/ws_SUITE_data/ws_timeout_cancel.erl
index 8883d2f..587f2c5 100644
--- a/test/ws_SUITE_data/ws_timeout_cancel.erl
+++ b/test/ws_SUITE_data/ws_timeout_cancel.erl
@@ -8,7 +8,9 @@
 
 init(Req, _) ->
 	erlang:start_timer(500, self(), should_not_cancel_timer),
-	{cowboy_websocket, Req, undefined, 1000}.
+	{cowboy_websocket, Req, undefined, #{
+		idle_timeout => 1000
+	}}.
 
 websocket_handle({text, Data}, State) ->
 	{reply, {text, Data}, State};
diff --git a/test/ws_SUITE_data/ws_timeout_hibernate.erl b/test/ws_SUITE_data/ws_timeout_hibernate.erl
index b9646ac..77f8348 100644
--- a/test/ws_SUITE_data/ws_timeout_hibernate.erl
+++ b/test/ws_SUITE_data/ws_timeout_hibernate.erl
@@ -3,11 +3,17 @@
 -module(ws_timeout_hibernate).
 
 -export([init/2]).
+-export([websocket_init/1]).
 -export([websocket_handle/2]).
 -export([websocket_info/2]).
 
 init(Req, _) ->
-	{cowboy_websocket, Req, undefined, 1000, hibernate}.
+	{cowboy_websocket, Req, undefined, #{
+		idle_timeout => 1000
+	}}.
+
+websocket_init(State) ->
+	{ok, State, hibernate}.
 
 websocket_handle(_Frame, State) ->
 	{ok, State, hibernate}.