Skip to content

Commit

Permalink
Confirm Websocket pong frames are received by handlers
Browse files Browse the repository at this point in the history
  • Loading branch information
essen committed Jan 16, 2024
1 parent 920adb9 commit 08a8d7b
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
23 changes: 23 additions & 0 deletions test/handlers/ws_ping_h.erl
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
%% This module sends an empty ping to the client and
%% waits for a pong before sending a text frame. It
%% is used to confirm server-initiated pings work.

-module(ws_ping_h).
-behavior(cowboy_websocket).

-export([init/2]).
-export([websocket_init/1]).
-export([websocket_handle/2]).
-export([websocket_info/2]).

init(Req, _) ->
{cowboy_websocket, Req, undefined}.

websocket_init(State) ->
{[{ping, <<>>}], State}.

websocket_handle(pong, State) ->
{[{text, <<"OK!!">>}], State}.

websocket_info(_, State) ->
{[], State}.
14 changes: 13 additions & 1 deletion test/ws_SUITE.erl
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ init_dispatch() ->
{"/ws_timeout_cancel", ws_timeout_cancel, []},
{"/ws_max_frame_size", ws_max_frame_size, []},
{"/ws_deflate_opts", ws_deflate_opts_h, []},
{"/ws_dont_validate_utf8", ws_dont_validate_utf8_h, []}
{"/ws_dont_validate_utf8", ws_dont_validate_utf8_h, []},
{"/ws_ping", ws_ping_h, []}
]}
]).

Expand Down Expand Up @@ -472,6 +473,17 @@ ws_max_frame_size_intermediate_fragment_close(Config) ->
{error, closed} = gen_tcp:recv(Socket, 0, 6000),
ok.

ws_ping(Config) ->
doc("Server initiated pings can receive a pong in response."),
{ok, Socket, _} = do_handshake("/ws_ping", Config),
%% Receive a server-sent ping.
{ok, << 1:1, 0:3, 9:4, 0:1, 0:7 >>} = gen_tcp:recv(Socket, 0, 6000),
%% Send a pong back with a 0 mask.
ok = gen_tcp:send(Socket, << 1:1, 0:3, 10:4, 1:1, 0:7, 0:32 >>),
%% Receive a text frame as a result.
{ok, << 1:1, 0:3, 1:4, 0:1, 4:7, "OK!!" >>} = gen_tcp:recv(Socket, 0, 6000),
ok.

ws_send_close(Config) ->
doc("Server-initiated close frame ends the connection."),
{ok, Socket, _} = do_handshake("/ws_send_close", Config),
Expand Down

0 comments on commit 08a8d7b

Please sign in to comment.