Add peer_disconnected_timeout option in Room.create (#62)

Author: Rados13

lib/jellyfish/room.ex

@@ -78,13 +78,16 @@ defmodule Jellyfish.Room do
       notifications from the room.
     * `:peerless_purge_timeout` - duration (in seconds) after which the room will be removed
       if no peers are connected. If not provided, this feature is disabled.
+    * `:peer_disconnected_timeout` - duration (in seconds) after which the peer will be removed
+      if it is disconnected. If not provided, this feature is disabled.
   """
   @type options :: [
           room_id: String.t() | nil,
           max_peers: non_neg_integer() | nil,
           video_codec: :h264 | :vp8 | nil,
           webhook_url: String.t() | nil,
-          peerless_purge_timeout: pos_integer() | nil
+          peerless_purge_timeout: pos_integer() | nil,
+          peer_disconnected_timeout: pos_integer() | nil
         ]
 
   @typedoc """
@@ -136,7 +139,8 @@ defmodule Jellyfish.Room do
              "maxPeers" => Keyword.get(opts, :max_peers),
              "videoCodec" => Keyword.get(opts, :video_codec),
              "webhookUrl" => Keyword.get(opts, :webhook_url),
-             "peerlessPurgeTimeout" => Keyword.get(opts, :peerless_purge_timeout)
+             "peerlessPurgeTimeout" => Keyword.get(opts, :peerless_purge_timeout),
+             "peerDisconnectedTimeout" => Keyword.get(opts, :peer_disconnected_timeout)
            }),
          room_json <- Map.fetch!(data, "room"),
          jellyfish_address <- Map.fetch!(data, "jellyfish_address"),

test/jellyfish/notifier_test.exs

@@ -30,6 +30,8 @@ defmodule Jellyfish.NotifierTest do
 
   @max_peers 10
   @video_codec :vp8
+  @peerless_purge_timeout_s 1
+  @peer_disconnected_timeout_s 1
   @webhook_port 4000
   @webhook_host Application.compile_env!(:jellyfish_server_sdk, :webhook_address)
   @webhook_address "http://#{@webhook_host}:#{@webhook_port}/"
@@ -140,6 +142,45 @@ defmodule Jellyfish.NotifierTest do
       :ok = Room.delete(client, room_id)
     end
 
+    test "when peer connects and then disconnects peer is removed with timeout", %{
+      client: client
+    } do
+      {:ok, %Jellyfish.Room{id: room_id}, jellyfish_address} =
+        Room.create(client,
+          max_peers: @max_peers,
+          video_codec: @video_codec,
+          webhook_url: @webhook_address,
+          peerless_purge_timeout: @peerless_purge_timeout_s,
+          peer_disconnected_timeout_s: @peer_disconnected_timeout_s
+        )
+
+      {:ok, %Jellyfish.Peer{id: peer_id}, peer_token} = Room.add_peer(client, room_id, @peer_opts)
+
+      {:ok, peer_ws} = WS.start_link("ws://#{jellyfish_address}/socket/peer/websocket")
+
+      auth_request = %PeerMessage{content: {:auth_request, %AuthRequest{token: peer_token}}}
+      :ok = WS.send_frame(peer_ws, auth_request)
+      {room_id, peer_id, peer_ws}
+
+      assert_receive {:jellyfish,
+                      %PeerConnected{peer_id: ^peer_id, room_id: ^room_id} = peer_connected}
+
+      assert_receive {:webhook, ^peer_connected}, 2_500
+
+      GenServer.stop(peer_ws)
+
+      assert_receive {:jellyfish,
+                      %PeerDisconnected{peer_id: ^peer_id, room_id: ^room_id} = peer_disconnected},
+                     1_000
+
+      assert_receive {:webhook, ^peer_disconnected}, 2_500
+
+      assert_receive {:jellyfish, %RoomDeleted{room_id: ^room_id} = room_deleted},
+                     2_500
+
+      assert_receive {:webhook, ^room_deleted}, 2_500
+    end
+
     @tag :file_component_sources
     test "TrackAdded and TrackRemoved are sent when adding and removing FileComponent", %{
       client: client

test/jellyfish/room_test.exs

@@ -186,6 +186,18 @@ defmodule Jellyfish.RoomTest do
       assert {:error, "Request failed: Expected videoCodec to be 'h264' or 'vp8', got: opus"} =
                Room.create(client, video_codec: @invalid_video_codec)
     end
+
+    test "when request is invalid, peerless purge timeout", %{client: client} do
+      assert {:error,
+              "Request failed: Expected peerlessPurgeTimeout to be a positive integer, got: -25"} =
+               Room.create(client, peerless_purge_timeout: -25)
+    end
+
+    test "when request is invalid, peer disconnected timeout", %{client: client} do
+      assert {:error,
+              "Request failed: Expected peerDisconnectedTimeout to be a positive integer, got: -25"} =
+               Room.create(client, peer_disconnected_timeout: -25)
+    end
   end
 
   describe "Room.delete/2" do