Packages
phoenix_live_view
1.2.0-rc.3
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc.3
1.2.0-rc.2
1.2.0-rc.1
1.2.0-rc.0
1.1.32
1.1.31
1.1.30
1.1.29
1.1.28
1.1.27
1.1.26
1.1.25
1.1.24
1.1.23
1.1.22
1.1.21
1.1.20
1.1.19
1.1.18
1.1.17
1.1.16
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
retired
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc.4
1.1.0-rc.3
1.1.0-rc.2
1.1.0-rc.1
1.1.0-rc.0
1.0.18
1.0.17
1.0.16
1.0.15
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
retired
1.0.7
1.0.6
retired
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
1.0.0-rc.9
1.0.0-rc.8
1.0.0-rc.7
1.0.0-rc.6
1.0.0-rc.5
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.20.17
0.20.16
0.20.15
0.20.14
0.20.13
0.20.12
0.20.11
0.20.10
0.20.9
0.20.8
0.20.7
0.20.6
0.20.5
0.20.4
0.20.3
0.20.2
0.20.1
0.20.0
0.19.5
0.19.4
0.19.3
0.19.2
0.19.1
0.19.0
0.18.18
0.18.17
0.18.16
0.18.15
0.18.14
0.18.13
0.18.12
0.18.11
0.18.10
0.18.9
0.18.8
0.18.7
0.18.6
0.18.5
0.18.4
0.18.3
0.18.2
0.18.1
0.18.0
0.17.14
0.17.13
0.17.12
0.17.11
0.17.10
0.17.9
0.17.8
0.17.7
0.17.6
0.17.5
0.17.4
0.17.3
0.17.2
0.17.1
0.17.0
0.16.4
0.16.3
0.16.2
0.16.1
0.16.0
0.15.7
0.15.6
0.15.5
0.15.4
0.15.3
0.15.2
0.15.1
0.15.0
0.14.8
0.14.7
0.14.6
0.14.5
0.14.4
0.14.3
0.14.2
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.1
0.12.0
0.11.1
0.11.0
0.10.0
0.9.0
0.8.1
0.8.0
0.7.1
0.7.0
0.6.0
0.6.0-dev
0.5.2
0.5.1
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.1
0.2.0
0.1.1
0.1.0
Rich, real-time user experiences with server-rendered HTML
Current section
Files
Jump to
Current section
Files
lib/phoenix_live_view/debug.ex
defmodule Phoenix.LiveView.Debug do
@moduledoc """
Functions for runtime introspection and debugging of LiveViews.
This module provides utilities for inspecting and debugging LiveView processes
at runtime. It allows you to:
* List all currently connected LiveViews
* Check if a process is a LiveView
* Get the socket of a LiveView process
* Inspect LiveComponents rendered in a LiveView
## Examples
# List all LiveViews
iex> Phoenix.LiveView.Debug.list_liveviews()
[%{pid: #PID<0.123.0>, view: MyAppWeb.PostLive.Index, topic: "lv:12345678", transport_pid: #PID<0.122.0>}]
# Check if a process is a LiveView
iex> Phoenix.LiveView.Debug.liveview_process?(pid(0,123,0))
true
# Get the socket of a LiveView process
iex> Phoenix.LiveView.Debug.socket(pid(0,123,0))
{:ok, %Phoenix.LiveView.Socket{...}}
# Get information about LiveComponents
iex> Phoenix.LiveView.Debug.live_components(pid(0,123,0))
{:ok, [%{id: "component-1", module: MyAppWeb.PostLive.Index.Component1, ...}]}
"""
@doc """
Returns a list of all currently connected LiveView processes (on the current node).
Each entry is a map with the following keys:
- `pid`: The PID of the LiveView process.
- `view`: The module of the LiveView.
- `topic`: The topic of the LiveView's channel.
- `transport_pid`: The PID of the transport process.
The `transport_pid` can be used to group LiveViews on the same page.
## Examples
iex> list_liveviews()
[%{pid: #PID<0.123.0>, view: MyAppWeb.PostLive.Index, topic: "lv:12345678", transport_pid: #PID<0.122.0>}]
"""
def list_liveviews do
for pid <- Process.list(), dict = lv_process_dict(pid), not is_nil(dict) do
{Phoenix.LiveView, view, topic} = keyfind(dict, :"$process_label")
%{pid: pid, view: view, topic: topic, transport_pid: keyfind(dict, :"$phx_transport_pid")}
end
end
defp keyfind(list, key) do
case List.keyfind(list, key, 0) do
{^key, value} -> value
_ -> nil
end
end
defp lv_process_dict(pid) do
# LiveViews set the "$process_label" to {Phoenix.LiveView, view, topic}
with info when is_list(info) <- Process.info(pid, [:dictionary]),
dictionary when not is_nil(dictionary) <- keyfind(info, :dictionary),
label when not is_nil(label) <- keyfind(dictionary, :"$process_label"),
{Phoenix.LiveView, view, topic} when is_atom(view) and is_binary(topic) <- label do
dictionary
else
_ -> nil
end
end
@doc """
Checks if the given pid is a LiveView process.
## Examples
iex> list_liveviews() |> Enum.at(0) |> Map.fetch!(:pid) |> liveview_process?()
true
iex> liveview_process?(pid(0,456,0))
false
"""
def liveview_process?(pid) do
not is_nil(lv_process_dict(pid))
end
@doc """
Returns the socket of the LiveView process.
## Examples
iex> list_liveviews() |> Enum.at(0) |> Map.fetch!(:pid) |> socket()
{:ok, %Phoenix.LiveView.Socket{...}}
iex> socket(pid(0,123,0))
{:error, :not_alive_or_not_a_liveview}
"""
def socket(liveview_pid) do
GenServer.call(liveview_pid, {:phoenix, :debug_get_socket})
catch
:exit, _ -> {:error, :not_alive_or_not_a_liveview}
end
@doc """
Returns a list with information about all LiveComponents rendered in the LiveView.
## Examples
iex> live_components(pid)
{:ok,
[
%{
id: "component-1",
module: MyAppWeb.PostLive.Index.Component1,
cid: 1,
assigns: %{
id: "component-1",
__changed__: %{},
flash: %{},
myself: %Phoenix.LiveComponent.CID{cid: 1},
...
}
}
]}
"""
def live_components(liveview_pid) do
GenServer.call(liveview_pid, {:phoenix, :debug_live_components})
catch
:exit, _ -> {:error, :not_alive_or_not_a_liveview}
end
end