Observer. Web. Page behaviour
(Observer Web v0.2.10)
View Source
Behaviour for dashboard pages, both the built-in pillars and custom pages provided by the host application.
A page is a Phoenix.LiveComponent that additionally implements this behaviour: the parent
Observer.Web.IndexLive LiveView forwards its mount, params, info and event callbacks to the
page currently being displayed.
Building a custom page
use Observer.Web.Page pulls in Phoenix.LiveComponent and provides overridable default
implementations for every callback, so a minimal page only needs render/1:
defmodule MyApp.ObserverQueuePage do
use Observer.Web.Page
@impl Phoenix.LiveComponent
def render(assigns) do
~H"""
<div class="min-h-screen bg-white dark:bg-gray-800 p-4">
Queue length: {@queue_length}
</div>
"""
end
@impl Observer.Web.Page
def handle_mount(socket) do
Phoenix.Component.assign(socket, :queue_length, MyApp.Queue.length())
end
endRegister the page under a route name when mounting the dashboard:
observer_dashboard "/observer", pages: [queue: MyApp.ObserverQueuePage]The page shows up in the navigation bar as QUEUE and is served at
/observer/queue. Within the component, the standard dashboard assigns are available:
@access (see Observer.Web.Resolver), @user, @params, @theme and @page.
Callback flow
handle_mount/1- called from the parent LiveView on mount and before page changes.handle_params/3- called on everyPhoenix.LiveView.handle_params/3.handle_info/2- called for any message the parent LiveView does not handle itself.handle_parent_event/3- called for anyphx-event the parent does not handle itself.
Access control
If a page performs any action that mutates the observed system - killing a process, writing
to an ETS table, anything a host might want to restrict to admins - handle_parent_event/3
must call Observer.Web.Resolver.enforce_access!/2 for that action before performing it, in
addition to disabling the triggering control with Observer.Web.Resolver.can?/2. Both matter:
disabling the control keeps a restricted user from seeing it as available, but only the
handler-side check stops a client that sends the underlying event directly, bypassing the
control entirely. Checking just one of the two is not enough - see the built-in pages (e.g.
Observer.Web.Apps.Page) for the pattern.
Summary
Callbacks
Called by parent live view on info messages.
Called from parent live view on mount and before page changes.
Called by parent live view on param changes.
Called by parent live view on handle_event messages.
Callbacks
@callback handle_info(message :: term(), socket :: Phoenix.LiveView.Socket.t()) :: {:noreply, Phoenix.LiveView.Socket.t()}
Called by parent live view on info messages.
@callback handle_mount(socket :: Phoenix.LiveView.Socket.t()) :: Phoenix.LiveView.Socket.t()
Called from parent live view on mount and before page changes.
@callback handle_params( params :: map(), uri :: String.t(), socket :: Phoenix.LiveView.Socket.t() ) :: {:noreply, Phoenix.LiveView.Socket.t()}
Called by parent live view on param changes.
@callback handle_parent_event( message :: term(), value :: term(), socket :: Phoenix.LiveView.Socket.t() ) :: {:noreply, Phoenix.LiveView.Socket.t()}
Called by parent live view on handle_event messages.