Phoenix.LiveView.Debug (Phoenix LiveView v1.1.3)

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, ...}]}

Summary

Functions

list_liveviews()

Returns a list of all currently connected LiveView processes (on the current node).

live_components(liveview_pid)

Returns a list with information about all LiveComponents rendered in the LiveView.

liveview_process?(pid)

Checks if the given pid is a LiveView process.

socket(liveview_pid)

Returns the socket of the LiveView process.

Functions

list_liveviews()

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>}]

live_components(liveview_pid)

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},
       ...
     }
   }
 ]}

liveview_process?(pid)

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

socket(liveview_pid)

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}