Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Improve LiveView flash messages (#3523)

Adrian Gruntkowski9b0a6e6e7dca
diff --git a/lib/plausible_web/live/flash.ex b/lib/plausible_web/live/flash.ex
index 384399011d..60a0c72a5e 100644
--- a/lib/plausible_web/live/flash.ex
+++ b/lib/plausible_web/live/flash.ex
@@ -2,15 +2,55 @@ defmodule PlausibleWeb.Live.Flash do
@moduledoc """
Flash component for LiveViews - works also when embedded within dead views
"""
- use Phoenix.LiveComponent
+
+ use Phoenix.Component
alias Phoenix.LiveView.JS
alias Phoenix.Flash
- def render(assigns) do
+ @flash_timer_assigns %{
+ success: :clear_flash_success,
+ error: :clear_flash_error
+ }
+
+ @flash_timer_timeout_ms 5000
+
+ defmacro __using__(_opts) do
+ quote do
+ import PlausibleWeb.Live.Flash, only: [put_live_flash: 3, flash_messages: 1]
+
+ def handle_info({:clear_live_flash, key}, socket) do
+ {:noreply, Phoenix.LiveView.clear_flash(socket, key)}
+ end
+ end
+ end
+
+ def put_live_flash(socket, key, message) when key in [:success, :error] do
+ timer_key = Map.fetch!(@flash_timer_assigns, key)
+
+ if flash_timer = socket.assigns[timer_key] do
+ Process.cancel_timer(flash_timer)
+ end
+
+ flash_timer =
+ Process.send_after(
+ self(),
+ {:clear_live_flash, key},
+ @flash_timer_timeout_ms
+ )
+
+ socket
+ |> Phoenix.LiveView.put_flash(key, message)
+ |> assign(timer_key, flash_timer)
+ end
+
+ def flash_messages(assigns) do
~H"""
<div id="liveview-flash">
- <div :if={@flash != %{}} class="">
- <.flash :if={Flash.get(@flash, :success)}>
+ <div
+ :if={@flash != %{} or Application.get_env(:plausible, :environment) == "dev"}
+ class="inset-0 z-50 fixed flex flex-col-reverse items-center sm:items-end justify-start sm:justify-end px-4 py-6 pointer-events-none sm:p-6"
+ >
+ <.flash :if={Flash.get(@flash, :success)} key="success">
<:icon>
<.icon_success />
</:icon>
@@ -21,7 +61,7 @@ defmodule PlausibleWeb.Live.Flash do
<%= Flash.get(@flash, :success) %>
</:message>
</.flash>
- <.flash :if={Flash.get(@flash, :error)}>
+ <.flash :if={Flash.get(@flash, :error)} key="error">
<:icon>
<.icon_error />
</:icon>
@@ -32,15 +72,14 @@ defmodule PlausibleWeb.Live.Flash do
<%= Flash.get(@flash, :error) %>
</:message>
</.flash>
- </div>
- <div
- :if={Application.get_env(:plausible, :environment) == "dev"}
- id="live-view-connection-status"
- class="hidden"
- phx-disconnected={JS.show()}
- phx-connected={JS.hide()}
- >
- <.flash on_close={JS.hide(to: "#live-view-connection-status")}>
+ <.flash
+ :if={Application.get_env(:plausible, :environment) == "dev"}
+ id="live-view-connection-status"
+ class="hidden"
+ phx-disconnected={JS.show()}
+ phx-connected={JS.hide()}
+ on_close={JS.hide()}
+ >
<:icon>
<.icon_error />
</:icon>
@@ -59,27 +98,34 @@ defmodule PlausibleWeb.Live.Flash do
slot(:icon, required: true)
slot(:title, require: true)
slot(:message, required: true)
+ attr(:key, :string, default: nil)
attr(:on_close, :any, default: "lv:clear-flash")
+ attr(:class, :string, default: "")
+ attr(:rest, :global)
def flash(assigns) do
~H"""
- <div class="inset-0 z-50 fixed flex items-end justify-center px-4 py-6 pointer-events-none sm:p-6 sm:items-start sm:justify-end">
- <div class="max-w-sm w-full bg-white dark:bg-gray-800 shadow-lg rounded-lg pointer-events-auto">
- <div class="rounded-lg ring-1 ring-black ring-opacity-5 overflow-hidden">
- <div class="p-4">
- <div class="flex items-start">
- <%= render_slot(@icon) %>
- <div class="ml-3 w-0 flex-1 pt-0.5">
- <p class="text-sm leading-5 font-medium text-gray-900 dark:text-gray-100">
- <%= render_slot(@title) %>
- </p>
- <p class="mt-1 text-sm leading-5 text-gray-500 dark:text-gray-200">
- <%= render_slot(@message) %>
- </p>
- </div>
- <div class="ml-4 flex-shrink-0 flex">
- <.clear_flash_button on_close={@on_close} />
- </div>
+ <div
+ class={[
+ @class,
+ "mb-4 max-w-sm w-full bg-white dark:bg-gray-800 shadow-lg rounded-lg pointer-events-auto"
+ ]}
+ {@rest}
+ >
+ <div class="rounded-lg ring-1 ring-black ring-opacity-5 overflow-hidden">
+ <div class="p-4">
+ <div class="flex items-start">
+ <%= render_slot(@icon) %>
+ <div class="ml-3 w-0 flex-1 pt-0.5">
+ <p class="text-sm leading-5 font-medium text-gray-900 dark:text-gray-100">
+ <%= render_slot(@title) %>
+ </p>
+ <p class="mt-1 text-sm leading-5 text-gray-500 dark:text-gray-200">
+ <%= render_slot(@message) %>
+ </p>
+ </div>
+ <div class="ml-4 flex-shrink-0 flex">
+ <.clear_flash_button on_close={@on_close} key={@key} />
</div>
</div>
</div>
@@ -134,6 +180,7 @@ defmodule PlausibleWeb.Live.Flash do
<button
class="inline-flex text-gray-400 focus:outline-none focus:text-gray-500 dark:focus:text-gray-200 transition ease-in-out duration-150"
phx-click={@on_close}
+ phx-value-key={@key}
>
<svg class="h-5 w-5" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor">
<path
diff --git a/lib/plausible_web/live/funnel_settings.ex b/lib/plausible_web/live/funnel_settings.ex
index 24336a4c9e..cf98c3ddc4 100644
--- a/lib/plausible_web/live/funnel_settings.ex
+++ b/lib/plausible_web/live/funnel_settings.ex
@@ -4,6 +4,7 @@ defmodule PlausibleWeb.Live.FunnelSettings do
"""
use Phoenix.LiveView
use Phoenix.HTML
+ use PlausibleWeb.Live.Flash
use Plausible.Funnel
@@ -41,7 +42,7 @@ defmodule PlausibleWeb.Live.FunnelSettings do
def render(assigns) do
~H"""
<div id="funnel-settings-main">
- <.live_component id="embedded_liveview_flash" module={PlausibleWeb.Live.Flash} flash={@flash} />
+ <.flash_messages flash={@flash} />
<%= if @add_funnel? do %>
<%= live_render(
@socket,
@@ -101,8 +102,7 @@ defmodule PlausibleWeb.Live.FunnelSettings do
id = String.to_integer(id)
:ok = Funnels.delete(site, id)
- socket = put_flash(socket, :success, "Funnel deleted successfully")
- Process.send_after(self(), :clear_flash, 5000)
+ socket = put_live_flash(socket, :success, "Funnel deleted successfully")
{:noreply,
assign(socket,
@@ -112,8 +112,7 @@ defmodule PlausibleWeb.Live.FunnelSettings do
end
def handle_info({:funnel_saved, funnel}, socket) do
- socket = put_flash(socket, :success, "Funnel saved successfully")
- Process.send_after(self(), :clear_flash, 5000)
+ socket = put_live_flash(socket, :success, "Funnel saved successfully")
{:noreply,
assign(socket,
@@ -126,8 +125,4 @@ defmodule PlausibleWeb.Live.FunnelSettings do
def handle_info(:cancel_add_funnel, socket) do
{:noreply, assign(socket, add_funnel?: false)}
end
-
- def handle_info(:clear_flash, socket) do
- {:noreply, clear_flash(socket)}
- end
end
diff --git a/lib/plausible_web/live/goal_settings.ex b/lib/plausible_web/live/goal_settings.ex
index 63e9264a06..0bf8b1b226 100644
--- a/lib/plausible_web/live/goal_settings.ex
+++ b/lib/plausible_web/live/goal_settings.ex
@@ -4,6 +4,7 @@ defmodule PlausibleWeb.Live.GoalSettings do
"""
use Phoenix.LiveView
use Phoenix.HTML
+ use PlausibleWeb.Live.Flash
use Plausible.Funnel
@@ -39,7 +40,7 @@ defmodule PlausibleWeb.Live.GoalSettings do
def render(assigns) do
~H"""
<div id="goal-settings-main">
- <.live_component id="embedded_liveview_flash" module={PlausibleWeb.Live.Flash} flash={@flash} />
+ <.flash_messages flash={@flash} />
<%= if @add_goal? do %>
<%= live_render(
@socket,
@@ -89,13 +90,12 @@ defmodule PlausibleWeb.Live.GoalSettings do
:ok ->
socket =
socket
- |> put_flash(:success, "Goal deleted successfully")
+ |> put_live_flash(:success, "Goal deleted successfully")
|> assign(
all_goals: Enum.reject(socket.assigns.all_goals, &(&1.id == goal_id)),
displayed_goals: Enum.reject(socket.assigns.displayed_goals, &(&1.id == goal_id))
)
- Process.send_after(self(), :clear_flash, 5000)
{:noreply, socket}
_ ->
@@ -116,12 +116,8 @@ defmodule PlausibleWeb.Live.GoalSettings do
all_goals: [goal | socket.assigns.all_goals],
displayed_goals: [goal | socket.assigns.all_goals]
)
- |> put_flash(:success, "Goal saved successfully")
+ |> put_live_flash(:success, "Goal saved successfully")
{:noreply, socket}
end
-
- def handle_info(:clear_flash, socket) do
- {:noreply, clear_flash(socket)}
- end
end
diff --git a/lib/plausible_web/live/plugins/api/settings.ex b/lib/plausible_web/live/plugins/api/settings.ex
index 7f48382db9..82b287ddd8 100644
--- a/lib/plausible_web/live/plugins/api/settings.ex
+++ b/lib/plausible_web/live/plugins/api/settings.ex
@@ -4,6 +4,7 @@ defmodule PlausibleWeb.Live.Plugins.API.Settings do
"""
use Phoenix.LiveView
use Phoenix.HTML
+ use PlausibleWeb.Live.Flash
alias Plausible.Sites
alias Plausible.Plugins.API.Tokens
@@ -33,7 +34,7 @@ defmodule PlausibleWeb.Live.Plugins.API.Settings do
def render(assigns) do
~H"""
- <.live_component id="embedded_liveview_flash" module={PlausibleWeb.Live.Flash} flash={@flash} />
+ <.flash_messages flash={@flash} />
<%= if @add_token? do %>
<%= live_render(
@@ -139,9 +140,7 @@ defmodule PlausibleWeb.Live.Plugins.API.Settings do
def handle_info({:token_added, token}, socket) do
displayed_tokens = [token | socket.assigns.displayed_tokens]
- socket = put_flash(socket, :success, "Plugins API Token created successfully")
-
- Process.send_after(self(), :clear_flash, 5000)
+ socket = put_live_flash(socket, :success, "Plugins API Token created successfully")
{:noreply,
assign(socket,
@@ -150,8 +149,4 @@ defmodule PlausibleWeb.Live.Plugins.API.Settings do
token_description: ""
)}
end
-
- def handle_info(:clear_flash, socket) do
- {:noreply, clear_flash(socket)}
- end
end
diff --git a/lib/plausible_web/live/props_settings.ex b/lib/plausible_web/live/props_settings.ex
index 7c6d54360d..d48c6fee39 100644
--- a/lib/plausible_web/live/props_settings.ex
+++ b/lib/plausible_web/live/props_settings.ex
@@ -5,6 +5,8 @@ defmodule PlausibleWeb.Live.PropsSettings do
use Phoenix.LiveView
use Phoenix.HTML
+ use PlausibleWeb.Live.Flash
+
alias PlausibleWeb.Live.Components.ComboBox
def mount(
@@ -37,7 +39,7 @@ defmodule PlausibleWeb.Live.PropsSettings do
def render(assigns) do
~H"""
<section id="props-settings-main">
- <.live_component id="embedded_liveview_flash" module={PlausibleWeb.Live.Flash} flash={@flash} />
+ <.flash_messages flash={@flash} />
<%= if @add_prop? do %>
<%= live_render(
@socket,
@@ -105,14 +107,13 @@ defmodule PlausibleWeb.Live.PropsSettings do
socket =
socket
- |> put_flash(:success, "Property removed successfully")
+ |> put_live_flash(:success, "Property removed successfully")
|> assign(
all_props: Enum.reject(socket.assigns.all_props, &(&1 == prop)),
displayed_props: Enum.reject(socket.assigns.displayed_props, &(&1 == prop)),
site: site
)
- Process.send_after(self(), :clear_flash, 5000)
{:noreply, socket}
end
@@ -139,7 +140,7 @@ defmodule PlausibleWeb.Live.PropsSettings do
displayed_props: props,
site: %{socket.assigns.site | allowed_event_props: props}
)
- |> put_flash(:success, "Properties added successfully")
+ |> put_live_flash(:success, "Properties added successfully")
{:noreply, socket}
end
@@ -160,15 +161,11 @@ defmodule PlausibleWeb.Live.PropsSettings do
displayed_props: allowed_event_props,
site: %{site | allowed_event_props: allowed_event_props}
)
- |> put_flash(:success, "Property added successfully")
+ |> put_live_flash(:success, "Property added successfully")
{:noreply, socket}
end
- def handle_info(:clear_flash, socket) do
- {:noreply, clear_flash(socket)}
- end
-
defp new_form(site) do
to_form(Plausible.Props.allow_changeset(site, []))
end
diff --git a/lib/plausible_web/live/sites.ex b/lib/plausible_web/live/sites.ex
index 8855fc6135..975c4056fc 100644
--- a/lib/plausible_web/live/sites.ex
+++ b/lib/plausible_web/live/sites.ex
@@ -4,6 +4,8 @@ defmodule PlausibleWeb.Live.Sites do
"""
use Phoenix.LiveView
+ use PlausibleWeb.Live.Flash
+
alias Phoenix.LiveView.JS
use Phoenix.HTML
@@ -59,7 +61,7 @@ defmodule PlausibleWeb.Live.Sites do
assigns = assign(assigns, :invitations, invitations)
~H"""
- <.live_component id="embedded_liveview_flash" module={PlausibleWeb.Live.Flash} flash={@flash} />
+ <.flash_messages flash={@flash} />
<div
x-data={"{selectedInvitation: null, invitationOpen: false, invitations: #{Enum.map(@invitations, &({&1.invitation_id, &1})) |> Enum.into(%{}) |> Jason.encode!}}"}
x-on:keydown.escape.window="invitationOpen = false"
@@ -593,7 +595,7 @@ defmodule PlausibleWeb.Live.Sites do
end
socket
- |> put_flash(:success, flash_message)
+ |> put_live_flash(:success, flash_message)
|> load_sites()
|> push_event("js-exec", %{
to: "#site-card-#{hash_domain(site.domain)}",
@@ -606,15 +608,13 @@ defmodule PlausibleWeb.Live.Sites do
"Please unpin one of your pinned sites to make room for new pins"
socket
- |> put_flash(:error, flash_message)
+ |> put_live_flash(:error, flash_message)
|> push_event("js-exec", %{
to: "#site-card-#{hash_domain(site.domain)}",
attr: "data-pin-failed"
})
end
- Process.send_after(self(), :clear_flash, 5000)
-
{:noreply, socket}
else
Sentry.capture_message("Attempting to toggle pin for invalid domain.",
@@ -651,10 +651,6 @@ defmodule PlausibleWeb.Live.Sites do
{:noreply, socket}
end
- def handle_info(:clear_flash, socket) do
- {:noreply, clear_flash(socket)}
- end
-
defp load_sites(%{assigns: assigns} = socket) do
sites =
Sites.list_with_invitations(assigns.user, assigns.params,