+ case profile.data do
+ %{exception: exception} ->
+ true
+
+ other ->
+ false
+ end
+ end)
+
+ assert capture_log(fn ->
+ # Errors in the Plug stack will not be caught by the profiler
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@debug}/oops", %{})
+ assert resp.status == 500
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@debug}/router/oops", %{})
+ assert resp.status == 500
+ assert [token] = HTTPClient.get_resp_header(resp, "x-debug-token")
+ assert [link] = HTTPClient.get_resp_header(resp, "x-debug-token-link")
+ assert link =~ "/dashboard/_profiler"
+
+ assert wait_for_profile_data(Profiler, token, fn %PhoenixProfiler.Profile{} = profile ->
+ case profile.data do
+ %{exception: exception} ->
+ true
+
+ other ->
+ false
+ end
+ end)
+
+ Supervisor.stop(DebugEndpoint)
+ end) =~ "** (RuntimeError) oops"
+ end
+
+ test "starts collector and injects headers and toolbar and saves profile to storage unless disabled for enabled" do
+ # with debug_errors: false
+ {:ok, _} = EnabledEndpoint.start_link([])
+
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@enabled}", %{})
+ assert resp.status == 200
+ assert [token] = HTTPClient.get_resp_header(resp, "x-debug-token")
+ assert [link] = HTTPClient.get_resp_header(resp, "x-debug-token-link")
+ assert link =~ "/dashboard/_profiler"
+ assert resp.body =~ ~s|
+ case profile.data do
+ %{exception: exception} ->
+ true
+
+ other ->
+ false
+ end
+ end)
+
+ # Disables the profiler on-demand
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@enabled}/router/disable", %{})
+ assert resp.status == 200
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+
+ assert capture_log(fn ->
+ # Errors in the Plug stack will not be caught by the Profiler
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@enabled}/oops", %{})
+ assert resp.status == 500
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+ assert link =~ "/dashboard/_profiler"
+
+ {:ok, resp} =
+ HTTPClient.request(:get, "http://127.0.0.1:#{@enabled}/router/oops", %{})
+
+ assert resp.status == 500
+ assert [token] = HTTPClient.get_resp_header(resp, "x-debug-token")
+ assert [link] = HTTPClient.get_resp_header(resp, "x-debug-token-link")
+ assert link =~ "/dashboard/_profiler"
+
+ assert wait_for_profile_data(Profiler, token, fn %PhoenixProfiler.Profile{} = profile ->
+ case profile.data do
+ %{exception: exception} ->
+ true
+
+ other ->
+ false
+ end
+ end)
+
+ Supervisor.stop(EnabledEndpoint)
+ end) =~ "** (RuntimeError) oops"
+ end
+
+ test "skips injecting headers and toolbar and profile storage unless enabled for disabled" do
+ {:ok, _} = DisabledEndpoint.start_link([])
+
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@disabled}", %{})
+ assert resp.status == 200
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+ refute resp.body =~ ~s|class="phxprof-toolbar"|
+
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@disabled}/unknown", %{})
+ assert resp.status == 404
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+ refute resp.body =~ ~s|class="phxprof-toolbar"|
+
+ # Enables the profiler on-demand
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@disabled}/router/enable", %{})
+ assert resp.status == 200
+ assert [token] = HTTPClient.get_resp_header(resp, "x-debug-token")
+ assert [link] = HTTPClient.get_resp_header(resp, "x-debug-token-link")
+ assert link =~ "/dashboard/_profiler"
+ assert resp.body =~ ~s|
+ {:ok, resp} =
+ HTTPClient.request(:get, "http://127.0.0.1:#{@disabled}/router/oops", %{})
+
+ assert resp.status == 500
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+
+ Supervisor.stop(DisabledEndpoint)
+ end) =~ "** (RuntimeError) oops"
+ end
+
+ test "skips headers and toolbar and profile storage for noconf" do
+ {:ok, _} = NotConfiguredEndpoint.start_link([])
+
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@noconf}", %{})
+ assert resp.status == 200
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+ refute resp.body =~ ~s|class="phxprof-toolbar"|
+
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@noconf}/unknown", %{})
+ assert resp.status == 404
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+ refute resp.body =~ ~s|class="phxprof-toolbar"|
+
+ assert capture_log(fn ->
+ {:ok, resp} = HTTPClient.request(:get, "http://127.0.0.1:#{@noconf}/oops", %{})
+ assert resp.status == 500
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+
+ {:ok, resp} =
+ HTTPClient.request(:get, "http://127.0.0.1:#{@noconf}/router/oops", %{})
+
+ assert resp.status == 500
+ assert HTTPClient.get_resp_header(resp, "x-debug-token") == []
+ assert HTTPClient.get_resp_header(resp, "x-debug-token-link") == []
+
+ Supervisor.stop(NotConfiguredEndpoint)
+ end) =~ "** (RuntimeError) oops"
+ end
+end
diff --git a/test/phoenix_profiler/integrations/phoenix_profiler_test.exs b/test/phoenix_profiler/integrations/phoenix_profiler_test.exs
index e0f4923..b67e68b 100644
--- a/test/phoenix_profiler/integrations/phoenix_profiler_test.exs
+++ b/test/phoenix_profiler/integrations/phoenix_profiler_test.exs
@@ -1,6 +1,7 @@
defmodule PhoenixProfiler.PhoenixProfilerTest do
use ExUnit.Case, async: true
import Phoenix.ConnTest
+ alias PhoenixProfiler.Profile
alias PhoenixProfiler.ProfileStore
alias PhoenixProfilerTest.Endpoint
@@ -22,24 +23,24 @@ defmodule PhoenixProfiler.PhoenixProfilerTest do
assert url ==
"http://localhost:4000/dashboard/_profiler?nav=PhoenixProfilerTest.Profiler&panel=request&token=#{token}"
- assert profiler = ProfileStore.profiler(conn)
-
- %{
- conn: %Plug.Conn{
- host: "www.example.com",
- method: "GET",
- path_info: [],
- private: %{
- phoenix_action: :index,
- phoenix_controller: PhoenixProfilerTest.PageController,
- phoenix_endpoint: PhoenixProfilerTest.Endpoint,
- phoenix_router: PhoenixProfilerTest.Router,
- phoenix_view: PhoenixProfilerTest.PageView
+ %Profile{
+ data: %{
+ conn: %Plug.Conn{
+ host: "www.example.com",
+ method: "GET",
+ path_info: [],
+ private: %{
+ phoenix_action: :index,
+ phoenix_controller: PhoenixProfilerTest.PageController,
+ phoenix_endpoint: PhoenixProfilerTest.Endpoint,
+ phoenix_router: PhoenixProfilerTest.Router,
+ phoenix_view: PhoenixProfilerTest.PageView
+ },
+ status: 200
},
- status: 200
- },
- metrics: metrics
- } = ProfileStore.get(profiler, token)
+ metrics: metrics
+ }
+ } = conn |> ProfileStore.profiler() |> ProfileStore.get(token)
assert metrics.total_duration > 0
assert metrics.endpoint_duration > 0
@@ -50,8 +51,7 @@ defmodule PhoenixProfiler.PhoenixProfilerTest do
conn = get(conn, "/plug-router")
assert [token] = Plug.Conn.get_resp_header(conn, @token_header_key)
assert [_] = Plug.Conn.get_resp_header(conn, @profiler_header_key)
- assert profiler = ProfileStore.profiler(conn)
- assert ProfileStore.get(profiler, token)
+ assert conn |> ProfileStore.profiler() |> ProfileStore.get(token)
end
test "profiling an api request", %{conn: conn} do
@@ -63,24 +63,24 @@ defmodule PhoenixProfiler.PhoenixProfilerTest do
assert url ==
"http://localhost:4000/dashboard/_profiler?nav=PhoenixProfilerTest.Profiler&panel=request&token=#{token}"
- assert profiler = ProfileStore.profiler(conn)
-
- %{
- conn: %Plug.Conn{
- host: "www.example.com",
- method: "GET",
- path_info: ["api"],
- private: %{
- phoenix_action: :index,
- phoenix_controller: PhoenixProfilerTest.APIController,
- phoenix_endpoint: PhoenixProfilerTest.Endpoint,
- phoenix_router: PhoenixProfilerTest.Router,
- phoenix_view: PhoenixProfilerTest.APIView
+ %Profile{
+ data: %{
+ conn: %Plug.Conn{
+ host: "www.example.com",
+ method: "GET",
+ path_info: ["api"],
+ private: %{
+ phoenix_action: :index,
+ phoenix_controller: PhoenixProfilerTest.APIController,
+ phoenix_endpoint: PhoenixProfilerTest.Endpoint,
+ phoenix_router: PhoenixProfilerTest.Router,
+ phoenix_view: PhoenixProfilerTest.APIView
+ },
+ status: 200
},
- status: 200
- },
- metrics: metrics
- } = ProfileStore.get(profiler, token)
+ metrics: metrics
+ }
+ } = conn |> ProfileStore.profiler() |> ProfileStore.get(token)
assert metrics.endpoint_duration > 0
assert metrics.memory > 0
@@ -91,10 +91,5 @@ defmodule PhoenixProfiler.PhoenixProfilerTest do
assert Plug.Conn.get_resp_header(conn, @token_header_key) == []
assert Plug.Conn.get_resp_header(conn, @profiler_header_key) == []
-
- assert %PhoenixProfiler.Profile{info: :disable, server: server, token: token} =
- conn.private.phoenix_profiler
-
- refute ProfileStore.get(server, token)
end
end
diff --git a/test/phoenix_profiler/live_view_test.exs b/test/phoenix_profiler/live_view_test.exs
new file mode 100644
index 0000000..640fbe7
--- /dev/null
+++ b/test/phoenix_profiler/live_view_test.exs
@@ -0,0 +1,50 @@
+defmodule PhoenixProfiler.LiveViewTest do
+ use ExUnit.Case
+ alias Phoenix.LiveView.Socket
+ alias PhoenixProfiler.Profile
+
+ defp build_socket(endpoint \\ PhoenixProfilerTest.Endpoint) do
+ %Socket{endpoint: endpoint}
+ end
+
+ defp connect(%Socket{} = socket) do
+ # TODO: replace with struct update when we require LiveView v0.15+.
+ socket = Map.put(socket, :transport_pid, self())
+
+ # TODO: remove when we require LiveView v0.15+.
+ if Map.has_key?(socket, :connected?) do
+ Map.put(socket, :connected?, true)
+ else
+ socket
+ end
+ end
+
+ describe "on_mount/4" do
+ test "when the socket is disconnected, is a no-op" do
+ socket = build_socket()
+ assert PhoenixProfiler.on_mount(:default, %{}, %{}, socket) == {:cont, socket}
+ end
+
+ test "when the profiler is enabled on the endpoint, configures an enabled profile" do
+ socket = build_socket() |> connect() |> PhoenixProfiler.Utils.maybe_mount_profiler()
+
+ assert {:cont, %{private: %{phoenix_profiler: %Profile{info: :enable}}}} =
+ PhoenixProfiler.on_mount(:default, %{}, %{}, socket)
+ end
+
+ test "when the profiler is disabled on the endpoint, configures a disabled profile" do
+ socket =
+ PhoenixProfilerTest.EndpointDisabled
+ |> build_socket()
+ |> connect()
+
+ assert {:cont, %Socket{private: %{phoenix_profiler: %Profile{info: :disable}}}} =
+ PhoenixProfiler.on_mount(:default, %{}, %{}, socket)
+ end
+
+ test "when the profiler is not defined on the endpoint, is a no-op" do
+ socket = PhoenixProfilerTest.EndpointNotConfigured |> build_socket() |> connect()
+ assert PhoenixProfiler.on_mount(:default, %{}, %{}, socket) == {:cont, socket}
+ end
+ end
+end
diff --git a/test/phoenix_profiler/plug_test.exs b/test/phoenix_profiler/plug_test.exs
index 04b2286..ed93fb9 100644
--- a/test/phoenix_profiler/plug_test.exs
+++ b/test/phoenix_profiler/plug_test.exs
@@ -1,23 +1,24 @@
defmodule PhoenixProfiler.PlugTest do
use ExUnit.Case, async: true
- import Plug.Test
- import Plug.Conn
+ use ProfilerHelper
@token_header_key "x-debug-token"
@profiler_header_key "x-debug-token-link"
-
defp conn(path) do
:get
|> conn(path)
|> put_private(:phoenix_endpoint, PhoenixProfilerTest.Endpoint)
+
+ conn(:get, path)
end
test "injects debug token headers if configured" do
- opts = PhoenixProfiler.init([])
+ opts = PhoenixProfiler.Plug.init([])
conn =
conn("/")
- |> PhoenixProfiler.call(opts)
+ |> profile_thru(PhoenixProfilerTest.Endpoint)
+ |> PhoenixProfiler.Plug.call(opts)
|> send_resp(200, "")
assert [token] = Plug.Conn.get_resp_header(conn, @token_header_key)
@@ -28,12 +29,12 @@ defmodule PhoenixProfiler.PlugTest do
end
test "skips debug token when disabled at the Endpoint" do
- opts = PhoenixProfiler.init([])
+ opts = PhoenixProfiler.Plug.init([])
conn =
conn("/")
- |> put_private(:phoenix_endpoint, PhoenixProfilerTest.EndpointDisabled)
- |> PhoenixProfiler.call(opts)
+ |> profile_thru(PhoenixProfilerTest.EndpointDisabled)
+ |> PhoenixProfiler.Plug.call(opts)
|> send_resp(200, "")
assert get_resp_header(conn, @token_header_key) == []
@@ -41,27 +42,29 @@ defmodule PhoenixProfiler.PlugTest do
end
test "injects debug toolbar for html requests if configured and contains the