Add suspended routes and handlers to error message

Author: danschultzer

CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.1.6 (2022-09-13)
+
+- Added suspended routes and web socket handlers to error messages
+
 ## v0.1.5 (2022-09-13)
 
 - `TestServer.websocket_info/2` now takes the callback function as second argument

lib/test_server.ex

@@ -88,7 +88,7 @@ defmodule TestServer do
 
       active_routes ->
         raise """
-        The test ended before the following #{inspect(Instance)} route(s) received a request:
+        The test ended before the following #{inspect(Instance)} #{inspect(instance)} route(s) received a request:
 
         #{Instance.format_routes(active_routes)}
         """
@@ -105,7 +105,7 @@ defmodule TestServer do
 
       active_websocket_handlers ->
         raise """
-        The test ended before the following #{inspect(Instance)} websocket handler(s) received a message:
+        The test ended before the following #{inspect(Instance)} #{inspect(instance)} websocket handler(s) received a message:
 
         #{Instance.format_websocket_handlers(active_websocket_handlers)}
         """

lib/test_server/plug_cowboy/handler.ex

@@ -37,14 +37,10 @@ defmodule TestServer.Plug.Cowboy.Handler do
         handle_reply(result, socket)
 
       {:error, :not_found} ->
-        message = """
-        Unexpected message received for WebSocket.
-
-        Frame:
-        #{inspect(frame)}
-
-        #{format_active_websocket_handlers(socket)}
-        """
+        message =
+          "Unexpected message received for WebSocket"
+          |> append_formatted_frame(frame)
+          |> append_formatted_websocket_handlers(socket)
 
         reply_with_error({socket, state}, {RuntimeError.exception(message), []})
 
@@ -59,21 +55,49 @@ defmodule TestServer.Plug.Cowboy.Handler do
     {:reply, {:text, Exception.format(:error, exception, stacktrace)}, state}
   end
 
-  defp format_active_websocket_handlers({instance, route_ref}) do
-    active_websocket_handlers =
-      Enum.filter(
-        Instance.websocket_handlers(instance),
-        &(not &1.suspended and &1.route_ref == route_ref)
-      )
+  defp append_formatted_frame(message, frame) do
+    """
+    #{message} with frame:
+
+    #{inspect(frame)}
+    """
+  end
+
+  defp append_formatted_websocket_handlers(message, {instance, route_ref}) do
+    websocket_handlers =
+      Instance.websocket_handlers(instance)
+      |> Enum.filter(&(&1.route_ref == route_ref))
+      |> Enum.split_with(&(not &1.suspended))
 
-    format_active_websocket_handlers(active_websocket_handlers)
+    """
+    #{message}
+
+    #{format_websocket_handlers(websocket_handlers, instance)}
+    """
+  end
+
+  defp format_websocket_handlers({[], suspended_websocket_handlers}, instance) do
+    message = "No active websocket handlers for #{inspect(Instance)} #{inspect(instance)}."
+
+    case suspended_websocket_handlers do
+      [] ->
+        message
+
+      websocket_handlers ->
+        """
+        #{message} The following websocket handler(s) have been processed:
+
+        #{Instance.format_routes(websocket_handlers)}"
+        """
+    end
   end
 
-  defp format_active_websocket_handlers([]),
-    do: "\n\nNo active websocket handlers"
+  defp format_websocket_handlers({active_websocket_handlers, _}, instance) do
+    """
+    Active websocket handler(s) #{inspect(Instance)} #{inspect(instance)}:
 
-  defp format_active_websocket_handlers(active_websocket_handlers) do
-    "\n\nActive websocket handler(s):\n\n#{Instance.format_websocket_handlers(active_websocket_handlers)}"
+    #{Instance.format_websocket_handlers(active_websocket_handlers)}
+    """
   end
 
   defp handle_reply({:reply, frame, state}, socket), do: {:reply, frame, {socket, state}}

lib/test_server/plug_cowboy/plug.ex

@@ -19,8 +19,8 @@ defmodule TestServer.Plug.Cowboy.Plug do
       {:error, {:not_found, conn}} ->
         message =
           "Unexpected #{conn.method} request received at #{conn.request_path}"
-          |> append_params(conn)
-          |> format_active_routes(instance)
+          |> append_formatted_params(conn)
+          |> append_formatted_routes(instance)
 
         resp_error(conn, instance, {RuntimeError.exception(message), []})
 
@@ -29,7 +29,7 @@ defmodule TestServer.Plug.Cowboy.Plug do
     end
   end
 
-  defp append_params(message, conn) do
+  defp append_formatted_params(message, conn) do
     conn
     |> Map.take([:query_params, :body_params])
     |> Enum.filter(fn
@@ -43,18 +43,38 @@ defmodule TestServer.Plug.Cowboy.Plug do
     end
   end
 
-  defp format_active_routes(message, instance) do
-    active_routes = Enum.reject(Instance.routes(instance), & &1.suspended)
+  defp append_formatted_routes(message, instance) do
+    routes = Enum.split_with(Instance.routes(instance), &(not &1.suspended))
 
-    format_active_routes(message, active_routes, instance)
+    """
+    #{message}
+
+    #{format_routes(routes, instance)}
+    """
+  end
+
+  defp format_routes({[], suspended_routes}, instance) do
+    message = "No active routes for #{inspect(Instance)} #{inspect(instance)}."
+
+    case suspended_routes do
+      [] ->
+        message
+
+      suspended_routes ->
+        """
+        #{message} The following route(s) have been processed:
+
+        #{Instance.format_routes(suspended_routes)}
+        """
+    end
   end
 
-  defp format_active_routes(message, [], instance),
-    do: message <> "\n\nNo active routes for #{inspect(Instance)} #{inspect(instance)}"
+  defp format_routes({active_routes, _suspended_routes}, instance) do
+    """
+    Active route(s) for #{inspect(Instance)} #{inspect(instance)}:
 
-  defp format_active_routes(message, active_routes, instance) do
-    message <>
-      "\n\nActive routes for #{inspect(Instance)} #{inspect(instance)}:\n\n#{Instance.format_routes(active_routes)}"
+    #{Instance.format_routes(active_routes)}
+    """
   end
 
   defp resp_error(conn, instance, {exception, stacktrace}) do

test/test_server_test.exs

@@ -70,7 +70,7 @@ defmodule TestServerTest do
         TestServer.stop()
       end
 
-      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<.*\> is not running/, fn ->
+      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<[0-9.]+\> is not running/, fn ->
         {:ok, instance} = TestServer.start()
 
         assert :ok = TestServer.stop()
@@ -131,7 +131,7 @@ defmodule TestServerTest do
         TestServer.url()
       end
 
-      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<.*\> is not running/, fn ->
+      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<[0-9.]+\> is not running/, fn ->
         {:ok, instance} = TestServer.start()
 
         assert :ok = TestServer.stop()
@@ -172,7 +172,7 @@ defmodule TestServerTest do
 
   describe "add/3" do
     test "when instance not running" do
-      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<.*\> is not running/, fn ->
+      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<[0-9.]+\> is not running/, fn ->
         {:ok, instance} = TestServer.start()
 
         assert :ok = TestServer.stop()
@@ -263,7 +263,7 @@ defmodule TestServerTest do
       end
 
       assert capture_io(fn -> ExUnit.run() end) =~
-               "The test ended before the following TestServer.Instance route(s) received a request"
+               ~r/The test ended before the following TestServer\.Instance \#PID\<[0-9.]+\> route\(s\) received a request/
     end
 
     test "with callback plug" do
@@ -404,7 +404,7 @@ defmodule TestServerTest do
         TestServer.x509_suite()
       end
 
-      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<.*\> is not running/, fn ->
+      assert_raise RuntimeError, ~r/The TestServer\.Instance \#PID\<[0-9.]+\> is not running/, fn ->
         {:ok, instance} = TestServer.start()
 
         assert :ok = TestServer.stop()
@@ -434,7 +434,7 @@ defmodule TestServerTest do
 
       TestServer.start(scheme: :https, cowboy_options: cowboy_options)
 
-      assert_raise RuntimeError, ~r/The TestServer.Instance is running with custom SSL/, fn ->
+      assert_raise RuntimeError, ~r/The TestServer\.Instance is running with custom SSL/, fn ->
         TestServer.x509_suite()
       end
     end
@@ -445,7 +445,7 @@ defmodule TestServerTest do
       {:ok, instance} = TestServer.start()
       assert :ok = TestServer.stop()
 
-      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<.*\> is not running/, fn ->
+      assert_raise RuntimeError, ~r/The TestServer\.Instance \#PID\<[0-9.]+\> is not running/, fn ->
         TestServer.websocket_init(instance, "/ws")
       end
     end
@@ -474,7 +474,7 @@ defmodule TestServerTest do
       assert {:ok, socket} = TestServer.websocket_init("/ws")
       assert :ok = TestServer.stop(instance)
 
-      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<.*\> is not running/, fn ->
+      assert_raise RuntimeError, ~r/The TestServer\.Instance \#PID\<[0-9.]+\> is not running/, fn ->
         TestServer.websocket_handle(socket)
       end
     end
@@ -501,7 +501,7 @@ defmodule TestServerTest do
       end
 
       assert capture_io(fn -> ExUnit.run() end) =~
-               "The test ended before the following TestServer.Instance websocket handler(s) received a message"
+               ~r/The test ended before the following TestServer\.Instance \#PID\<[0-9.]+\> websocket handler\(s\) received a message/
     end
 
     test "when receiving unexpected message" do
@@ -593,7 +593,7 @@ defmodule TestServerTest do
       assert {:ok, socket} = TestServer.websocket_init("/ws")
       assert :ok = TestServer.stop(instance)
 
-      assert_raise RuntimeError, ~r/The TestServer.Instance \#PID\<.*\> is not running/, fn ->
+      assert_raise RuntimeError, ~r/The TestServer\.Instance \#PID\<[0-9.]+\> is not running/, fn ->
         TestServer.websocket_info(socket)
       end
     end