From fa5ed72ccec0c68bfa412ff09b3f46863dac83e6 Mon Sep 17 00:00:00 2001 From: Adam Rutkowski Date: Thu, 24 Aug 2023 15:25:11 +0200 Subject: [PATCH] Implement new goal settings --- lib/plausible/goal/schema.ex | 4 +- lib/plausible_web/live/components/form.ex | 106 +++++++ lib/plausible_web/live/goal_settings.ex | 128 ++++++++ lib/plausible_web/live/goal_settings/form.ex | 274 ++++++++++++++++++ lib/plausible_web/live/goal_settings/list.ex | 142 +++++++++ .../templates/site/settings_goals.html.heex | 75 +---- test/plausible/goals_test.exs | 29 +- .../live/goal_settings/form_test.exs | 166 +++++++++++ .../plausible_web/live/goal_settings_test.exs | 177 +++++++++++ 9 files changed, 1032 insertions(+), 69 deletions(-) create mode 100644 lib/plausible_web/live/components/form.ex create mode 100644 lib/plausible_web/live/goal_settings.ex create mode 100644 lib/plausible_web/live/goal_settings/form.ex create mode 100644 lib/plausible_web/live/goal_settings/list.ex create mode 100644 test/plausible_web/live/goal_settings/form_test.exs create mode 100644 test/plausible_web/live/goal_settings_test.exs diff --git a/lib/plausible/goal/schema.ex b/lib/plausible/goal/schema.ex index 98a0bc78a..63393ea0e 100644 --- a/lib/plausible/goal/schema.ex +++ b/lib/plausible/goal/schema.ex @@ -27,10 +27,10 @@ defmodule Plausible.Goal do def currency_options do options = for code <- valid_currencies() do - {"#{code} - #{Cldr.Currency.display_name!(code)}", code} + {code, "#{code} - #{Cldr.Currency.display_name!(code)}"} end - [{"Select reporting currency", nil}] ++ options + options end def changeset(goal, attrs \\ %{}) do diff --git a/lib/plausible_web/live/components/form.ex b/lib/plausible_web/live/components/form.ex new file mode 100644 index 000000000..fda15cd63 --- /dev/null +++ b/lib/plausible_web/live/components/form.ex @@ -0,0 +1,106 @@ +defmodule PlausibleWeb.Live.Components.Form do + use Phoenix.Component + + @doc """ + Renders an input with label and error messages. + + A `Phoenix.HTML.FormField` may be passed as argument, + which is used to retrieve the input name, id, and values. + Otherwise all attributes may be passed explicitly. + + ## Examples + + <.input field={@form[:email]} type="email" /> + <.input name="my-input" errors={["oh no!"]} /> + """ + attr(:id, :any, default: nil) + attr(:name, :any) + attr(:label, :string, default: nil) + attr(:value, :any) + + attr(:type, :string, + default: "text", + values: ~w(checkbox color date datetime-local email file hidden month number password + range radio search select tel text textarea time url week) + ) + + attr(:field, Phoenix.HTML.FormField, + doc: "a form field struct retrieved from the form, for example: @form[:email]" + ) + + attr(:errors, :list, default: []) + attr(:checked, :boolean, doc: "the checked flag for checkbox inputs") + attr(:prompt, :string, default: nil, doc: "the prompt for select inputs") + attr(:options, :list, doc: "the options to pass to Phoenix.HTML.Form.options_for_select/2") + attr(:multiple, :boolean, default: false, doc: "the multiple flag for select inputs") + + attr(:rest, :global, + include: ~w(accept autocomplete capture cols disabled form list max maxlength min minlength + multiple pattern placeholder readonly required rows size step) + ) + + slot(:inner_block) + + def input(%{field: %Phoenix.HTML.FormField{} = field} = assigns) do + assigns + |> assign(field: nil, id: assigns.id || field.id) + |> assign(:errors, Enum.map(field.errors, &translate_error(&1))) + |> assign_new(:name, fn -> if assigns.multiple, do: field.name <> "[]", else: field.name end) + |> assign_new(:value, fn -> field.value end) + |> input() + end + + # All other inputs text, datetime-local, url, password, etc. are handled here... + def input(assigns) do + ~H""" +
+ <.label for={@id}> + <%= @label %> + + + <.error :for={msg <- @errors}> + <%= msg %> + +
+ """ + end + + @doc """ + Renders a label. + """ + attr(:for, :string, default: nil) + slot(:inner_block, required: true) + + def label(assigns) do + ~H""" + + """ + end + + @doc """ + Generates a generic error message. + """ + slot(:inner_block, required: true) + + def error(assigns) do + ~H""" +

+ <%= render_slot(@inner_block) %> +

+ """ + end + + def translate_error({msg, opts}) do + Enum.reduce(opts, msg, fn {key, value}, acc -> + String.replace(acc, "%{#{key}}", fn _ -> to_string(value) end) + end) + end +end diff --git a/lib/plausible_web/live/goal_settings.ex b/lib/plausible_web/live/goal_settings.ex new file mode 100644 index 000000000..d4cae77e8 --- /dev/null +++ b/lib/plausible_web/live/goal_settings.ex @@ -0,0 +1,128 @@ +defmodule PlausibleWeb.Live.GoalSettings do + @moduledoc """ + LiveView allowing listing, creating and deleting goals. + """ + use Phoenix.LiveView + use Phoenix.HTML + + use Plausible.Funnel + + alias Plausible.{Sites, Goals} + + def mount( + _params, + %{"site_id" => _site_id, "domain" => domain, "current_user_id" => user_id}, + socket + ) do + site = + if Plausible.Auth.is_super_admin?(user_id) do + Sites.get_by_domain(domain) + else + Sites.get_for_user!(user_id, domain, [:owner, :admin]) + end + + goals = Goals.for_site(site, preload_funnels?: true) + + {:ok, + assign(socket, + site_id: site.id, + domain: site.domain, + goals: goals, + list: goals, + add_goal?: false, + current_user_id: user_id, + filter_text: "" + )} + end + + # Flash sharing with live views within dead views can be done via re-rendering the flash partial. + # Normally, we'd have to use live_patch which we can't do with views unmounted at the router it seems. + def render(assigns) do + ~H""" +
+ <.live_component id="embedded_liveview_flash" module={PlausibleWeb.Live.Flash} flash={@flash} /> + <%= if @add_goal? do %> + <%= live_render( + @socket, + PlausibleWeb.Live.GoalSettings.Form, + id: "goals-form", + session: %{ + "current_user_id" => @current_user_id, + "domain" => @domain, + "site_id" => @site_id, + "rendered_by" => self() + } + ) %> + <% end %> + <.live_component + module={PlausibleWeb.Live.GoalSettings.List} + id="goals-list" + goals={@list} + domain={@domain} + filter_text={@filter_text} + /> +
+ """ + end + + def handle_event("reset-filter-text", _params, socket) do + {:noreply, assign(socket, filter_text: "", list: socket.assigns.goals)} + end + + def handle_event("filter", %{"filter-text" => filter_text}, socket) do + new_list = + PlausibleWeb.Live.Components.ComboBox.StaticSearch.suggest( + filter_text, + socket.assigns.goals + ) + + {:noreply, assign(socket, list: new_list, filter_text: filter_text)} + end + + def handle_event("add-goal", _value, socket) do + {:noreply, assign(socket, add_goal?: true)} + end + + def handle_event("delete-goal", %{"goal-id" => goal_id}, socket) do + goal_id = String.to_integer(goal_id) + + case Plausible.Goals.delete(goal_id, socket.assigns.site_id) do + :ok -> + socket = + socket + |> put_flash(:success, "Goal deleted successfully") + |> assign( + goals: Enum.reject(socket.assigns.goals, &(&1.id == goal_id)), + list: Enum.reject(socket.assigns.list, &(&1.id == goal_id)) + ) + + Process.send_after(self(), :clear_flash, 5000) + {:noreply, socket} + + _ -> + {:noreply, socket} + end + end + + def handle_info(:cancel_add_goal, socket) do + {:noreply, assign(socket, add_goal?: false)} + end + + def handle_info({:goal_added, goal}, socket) do + socket = + socket + |> assign( + add_goal?: false, + filter_text: "", + goals: [goal | socket.assigns.goals], + list: [goal | socket.assigns.goals] + ) + |> put_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/goal_settings/form.ex b/lib/plausible_web/live/goal_settings/form.ex new file mode 100644 index 000000000..0e4a9b0d5 --- /dev/null +++ b/lib/plausible_web/live/goal_settings/form.ex @@ -0,0 +1,274 @@ +defmodule PlausibleWeb.Live.GoalSettings.Form do + @moduledoc """ + Live view for the goal creation form + """ + use Phoenix.LiveView + import PlausibleWeb.Live.Components.Form + alias PlausibleWeb.Live.Components.ComboBox + + alias Plausible.Repo + + def mount( + _params, + %{ + "site_id" => _site_id, + "current_user_id" => user_id, + "domain" => domain, + "rendered_by" => pid + }, + socket + ) do + form = to_form(Plausible.Goal.changeset(%Plausible.Goal{})) + + site = + if Plausible.Auth.is_super_admin?(user_id) do + Plausible.Sites.get_by_domain(domain) + else + Plausible.Sites.get_for_user!(user_id, domain, [:owner, :admin]) + end + + initial_suggestions = suggest("", nil, site) + + {:ok, + assign(socket, + current_user: Repo.get(Plausible.Auth.User, user_id), + form: form, + suggestions: initial_suggestions, + domain: domain, + rendered_by: pid, + tabs: %{custom_events: true, pageviews: false}, + site: site + )} + end + + def render(assigns) do + ~H""" +
+
+
+
+ <.form + :let={f} + for={@form} + class="max-w-md w-full mx-auto bg-white dark:bg-gray-800 shadow-md rounded px-8 pt-6 pb-8 mb-4 mt-8" + phx-submit="save-goal" + phx-click-away="cancel-add-goal" + > +

Add goal for <%= @domain %>

+ + <.tabs tabs={@tabs} /> + + <.custom_event_fields :if={@tabs.custom_events} f={f} /> + <.pageview_fields :if={@tabs.pageviews} f={f} suggestions={@suggestions} site={@site} /> + +
+ +
+ +
+
+ """ + end + + attr(:f, Phoenix.HTML.Form) + attr(:suggestions, :list) + attr(:site, Plausible.Site) + + def pageview_fields(assigns) do + ~H""" +
+ <.label for="page_path_input"> + Page path + + + <.live_component + id="page_path_input" + submit_name="goal[page_path]" + class={[ + "py-2" + ]} + module={ComboBox} + options={@suggestions} + suggest_fun={fn input, options -> suggest(input, options, @site) end} + creatable + /> + + <.error :for={{msg, opts} <- @f[:page_path].errors}> + <%= Enum.reduce(opts, msg, fn {key, value}, acc -> + String.replace(acc, "%{#{key}}", fn _ -> to_string(value) end) + end) %> + +
+ """ + end + + attr(:f, Phoenix.HTML.Form) + + def custom_event_fields(assigns) do + ~H""" +
+
+
+ Custom events are not tracked by default - you have to configure them on your site to be sent to Plausible. See examples and learn more in our docs. +
+ +
+ <.input + autofocus + field={@f[:event_name]} + label="Event name" + class="focus:ring-indigo-500 focus:border-indigo-500 dark:bg-gray-900 dark:text-gray-300 block w-7/12 rounded-md sm:text-sm border-gray-300 dark:border-gray-500 w-full p-2 mt-2" + placeholder="e.g. Signup" + autocomplete="off" + /> +
+ +
+
+ + + Enable revenue tracking + +
+ +
+

+ Revenue tracking is an upcoming premium feature that's free-to-use + during the private preview. Pricing will be announced soon. See + examples and learn more in our docs. +

+
+ +
+ <.live_component + id="currency_input" + submit_name={@f[:currency].name} + module={ComboBox} + options={Plausible.Goal.currency_options()} + suggest_fun={&PlausibleWeb.Live.Components.ComboBox.StaticSearch.suggest/2} + /> +
+
+
+
+ """ + end + + def tabs(assigns) do + ~H""" +
Goal trigger
+
+ <.custom_events_tab tabs={@tabs} /> + <.pageviews_tab tabs={@tabs} /> +
+ """ + end + + defp custom_events_tab(assigns) do + ~H""" + + Custom event + + """ + end + + def pageviews_tab(assigns) do + ~H""" + + Pageview + + """ + end + + def handle_event("switch-tab", _params, socket) do + {:noreply, + assign(socket, + tabs: %{ + custom_events: !socket.assigns.tabs.custom_events, + pageviews: !socket.assigns.tabs.pageviews + } + )} + end + + def handle_event("save-goal", %{"goal" => goal}, socket) do + case Plausible.Goals.create(socket.assigns.site, goal) do + {:ok, goal} -> + send(socket.assigns.rendered_by, {:goal_added, Map.put(goal, :funnels, [])}) + {:noreply, socket} + + {:error, changeset} -> + {:noreply, assign(socket, form: to_form(changeset))} + end + end + + def handle_event("cancel-add-goal", _value, socket) do + send(socket.assigns.rendered_by, :cancel_add_goal) + {:noreply, socket} + end + + def suggest(input, _options, site) do + query = Plausible.Stats.Query.from(site, %{}) + + site + |> Plausible.Stats.filter_suggestions(query, "page", input) + |> Enum.map(fn %{label: label, value: value} -> {label, value} end) + end +end diff --git a/lib/plausible_web/live/goal_settings/list.ex b/lib/plausible_web/live/goal_settings/list.ex new file mode 100644 index 000000000..f927d22cd --- /dev/null +++ b/lib/plausible_web/live/goal_settings/list.ex @@ -0,0 +1,142 @@ +defmodule PlausibleWeb.Live.GoalSettings.List do + @moduledoc """ + Phoenix LiveComponent module that renders a list of goals + """ + use Phoenix.LiveComponent + use Phoenix.HTML + + use Plausible.Funnel + alias Phoenix.LiveView.JS + + attr(:goals, :list, required: true) + attr(:domain, :string, required: true) + attr(:filter_text, :string) + + def render(assigns) do + ~H""" +
+
+
+
+ + + +
+
+
+ +
+
+ <%= if Enum.count(@goals) > 0 do %> +
+ <%= for goal <- @goals do %> +
+ +
+ + <%= goal %> +
+ + Pageview + Custom Event + + Revenue Goal: <%= goal.currency %> + + - belongs to funnel(s) + +
+
+
+ +
+ <% end %> +
+ <% else %> +

+ + No goals found for this site. Please refine or + + reset your search. + + + + No goals configured for this site. + +

+ <% end %> +
+ """ + end + + defp delete_confirmation_text(goal) do + if Enum.empty?(goal.funnels) do + """ + Are you sure you want to remove the following goal: + + #{goal} + + This will just affect the UI, all of your analytics data will stay intact. + """ + else + """ + The goal: + + #{goal} + + is part of some funnel(s). If you are going to delete it, the associated funnels will be either reduced or deleted completely. Are you sure you want to remove the goal? + """ + end + end +end diff --git a/lib/plausible_web/templates/site/settings_goals.html.heex b/lib/plausible_web/templates/site/settings_goals.html.heex index 1ce801c17..064578ac6 100644 --- a/lib/plausible_web/templates/site/settings_goals.html.heex +++ b/lib/plausible_web/templates/site/settings_goals.html.heex @@ -1,8 +1,14 @@

Goals

-

- Define actions that you want your users to take like visiting a certain page, submitting a form, etc. +

+ Define actions that you want your users to take, like visiting a certain page, submitting a form, etc. +

+

+ You can also compose goals into funnels.

<%= link(to: "https://plausible.io/docs/goal-conversions", target: "_blank", rel: "noreferrer") do %> @@ -28,69 +34,8 @@ label="Show goals in the dashboard" conn={@conn} > - <%= if Enum.count(@goals) > 0 do %> -
- <%= for goal <- @goals do %> -
- - <%= goal %> - - - <%= if not Enum.empty?(goal.funnels) do %> - <%= button(to: "/#{URI.encode_www_form(@site.domain)}/goals/#{goal.id}", method: :delete, class: "text-sm text-red-600", data: [confirm: "The goal '#{goal}' is part of some funnel(s). If you are going to delete it, the associated funnels will be either reduced or deleted completely. Are you sure you want to remove goal '#{goal}'?"]) do %> - - - - - - - - <% end %> - <% else %> - <%= button(to: "/#{URI.encode_www_form(@site.domain)}/goals/#{goal.id}", method: :delete, class: "text-sm text-red-600", data: [confirm: "Are you sure you want to remove goal '#{goal}'? This will just affect the UI, all of your analytics data will stay intact."]) do %> - - - - - - - - <% end %> - <% end %> -
- <% end %> -
- <% else %> -
No goals configured for this site yet
- <% end %> - - <%= link("+ Add goal", - to: "/#{URI.encode_www_form(@site.domain)}/goals/new", - class: "button mt-6" + <%= live_render(@conn, PlausibleWeb.Live.GoalSettings, + session: %{"site_id" => @site.id, "domain" => @site.domain} ) %> - <%= if Enum.count(@goals) >= Funnel.min_steps() and Plausible.Funnels.enabled_for?(@current_user) do %> - <%= link("Set up funnels", - to: Routes.site_path(@conn, :settings_funnels, @site.domain), - class: "mt-6 ml-2 text-indigo-500 underline text-sm" - ) %> - <% end %>
diff --git a/test/plausible/goals_test.exs b/test/plausible/goals_test.exs index 54f026a55..b0fb2421d 100644 --- a/test/plausible/goals_test.exs +++ b/test/plausible/goals_test.exs @@ -3,7 +3,7 @@ defmodule Plausible.GoalsTest do alias Plausible.Goals - test "create/2 trims input" do + test "create/2 creates goals and trims input" do site = insert(:site) {:ok, goal} = Goals.create(site, %{"page_path" => "/foo bar "}) assert goal.page_path == "/foo bar" @@ -32,7 +32,32 @@ defmodule Plausible.GoalsTest do :eq end - test "for_site2 returns trimmed input even if it was saved with trailing whitespace" do + test "create/2 creates revenue goal" do + site = insert(:site) + {:ok, goal} = Goals.create(site, %{"event_name" => "Purchase", "currency" => "EUR"}) + assert goal.event_name == "Purchase" + assert goal.page_path == nil + assert goal.currency == :EUR + end + + test "create/2 fails for unknown currency code" do + site = insert(:site) + + assert {:error, changeset} = + Goals.create(site, %{"event_name" => "Purchase", "currency" => "Euro"}) + + assert [currency: {"is invalid", _}] = changeset.errors + end + + test "create/2 clears currency for pageview goals" do + site = insert(:site) + {:ok, goal} = Goals.create(site, %{"page_path" => "/purchase", "currency" => "EUR"}) + assert goal.event_name == nil + assert goal.page_path == "/purchase" + assert goal.currency == nil + end + + test "for_site/1 returns trimmed input even if it was saved with trailing whitespace" do site = insert(:site) insert(:goal, %{site: site, event_name: " Signup "}) insert(:goal, %{site: site, page_path: " /Signup "}) diff --git a/test/plausible_web/live/goal_settings/form_test.exs b/test/plausible_web/live/goal_settings/form_test.exs new file mode 100644 index 000000000..3610e3f3c --- /dev/null +++ b/test/plausible_web/live/goal_settings/form_test.exs @@ -0,0 +1,166 @@ +defmodule PlausibleWeb.Live.GoalSettings.FormTest do + use PlausibleWeb.ConnCase, async: true + import Phoenix.LiveViewTest + import Plausible.Test.Support.HTML + + describe "integration - live rendering" do + setup [:create_user, :log_in, :create_site] + + test "tabs switching", %{conn: conn, site: site} do + setup_goals(site) + lv = get_liveview(conn, site) + + html = lv |> render() + + assert element_exists?(html, ~s/a#pageview-tab/) + assert element_exists?(html, ~s/a#event-tab/) + + pageview_tab = lv |> element(~s/a#pageview-tab/) |> render_click() + assert pageview_tab =~ "Page path" + + event_tab = lv |> element(~s/a#event-tab/) |> render_click() + assert event_tab =~ "Event name" + end + + test "escape closes the form", %{conn: conn, site: site} do + {parent, lv} = get_liveview(conn, site, with_parent?: true) + html = render(parent) + assert html =~ "Goal trigger" + render_keydown(lv, "cancel-add-goal") + html = render(parent) + refute html =~ "Goal trigger" + end + end + + describe "Goal submission" do + setup [:create_user, :log_in, :create_site] + + test "renders form fields", %{conn: conn, site: site} do + lv = get_liveview(conn, site) + html = render(lv) + + [event_name, currency_display, currency_submit] = find(html, "input") + + assert name_of(event_name) == "goal[event_name]" + assert name_of(currency_display) == "display-currency_input" + assert name_of(currency_submit) == "goal[currency]" + + html = lv |> element(~s/a#pageview-tab/) |> render_click() + + [page_path_display, page_path] = find(html, "input") + assert name_of(page_path_display) == "display-page_path_input" + assert name_of(page_path) == "goal[page_path]" + end + + test "renders error on empty submission", %{conn: conn, site: site} do + lv = get_liveview(conn, site) + html = lv |> element("form") |> render_submit() + assert html =~ "this field is required and cannot be blank" + + pageview_tab = lv |> element(~s/a#pageview-tab/) |> render_click() + assert pageview_tab =~ "this field is required and must start with a /" + end + + test "creates a custom event", %{conn: conn, site: site} do + {parent, lv} = get_liveview(conn, site, with_parent?: true) + refute render(parent) =~ "Foo" + lv |> element("form") |> render_submit(%{goal: %{event_name: "Foo"}}) + parent_html = render(parent) + assert parent_html =~ "Foo" + assert parent_html =~ "Custom Event" + end + + test "creates a revenue goal", %{conn: conn, site: site} do + {parent, lv} = get_liveview(conn, site, with_parent?: true) + refute render(parent) =~ "Foo" + lv |> element("form") |> render_submit(%{goal: %{event_name: "Foo", currency: "EUR"}}) + parent_html = render(parent) + assert parent_html =~ "Foo" + assert parent_html =~ "Revenue Goal: EUR" + end + + test "creates a pageview goal", %{conn: conn, site: site} do + {parent, lv} = get_liveview(conn, site, with_parent?: true) + refute render(parent) =~ "Foo" + lv |> element("form") |> render_submit(%{goal: %{page_path: "/page/**"}}) + parent_html = render(parent) + assert parent_html =~ "Visit /page/**" + assert parent_html =~ "Pageview" + end + end + + describe "Combos integration" do + setup [:create_user, :log_in, :create_site] + + test "currency combo works", %{conn: conn, site: site} do + lv = get_liveview(conn, site) + + html = type_into_combo(lv, "currency_input", "Polish") + + assert element_exists?(html, ~s/a[phx-value-display-value="PLN - Polish Zloty"]/) + refute element_exists?(html, ~s/a[phx-value-display-value="EUR - Euro"]/) + + html = type_into_combo(lv, "currency_input", "Euro") + + refute element_exists?(html, ~s/a[phx-value-display-value="PLN - Polish Zloty"]/) + assert element_exists?(html, ~s/a[phx-value-display-value="EUR - Euro"]/) + end + + test "pageview combo works", %{conn: conn, site: site} do + lv = get_liveview(conn, site) + lv |> element(~s/a#pageview-tab/) |> render_click() + + html = type_into_combo(lv, "page_path_input", "/hello") + + assert html =~ "Create "/hello"" + end + + test "pageview combo uses filter suggestions", %{conn: conn, site: site} do + populate_stats(site, [ + build(:pageview, pathname: "/go/to/page/1"), + build(:pageview, pathname: "/go/home") + ]) + + lv = get_liveview(conn, site) + lv |> element(~s/a#pageview-tab/) |> render_click() + + html = type_into_combo(lv, "page_path_input", "/go/to/p") + assert html =~ "Create "/go/to/p"" + assert html =~ "/go/to/page/1" + refute html =~ "/go/home" + + html = type_into_combo(lv, "page_path_input", "/go/h") + assert html =~ "/go/home" + refute html =~ "/go/to/page/1" + end + end + + defp type_into_combo(lv, id, text) do + lv + |> element("input##{id}") + |> render_change(%{ + "_target" => ["display-#{id}"], + "display-#{id}" => "#{text}" + }) + end + + defp setup_goals(site) do + {:ok, g1} = Plausible.Goals.create(site, %{"page_path" => "/go/to/blog/**"}) + {:ok, g2} = Plausible.Goals.create(site, %{"event_name" => "Signup"}) + {:ok, g3} = Plausible.Goals.create(site, %{"event_name" => "Purchase", "currency" => "EUR"}) + {:ok, [g1, g2, g3]} + end + + defp get_liveview(conn, site, opts \\ []) do + conn = assign(conn, :live_module, PlausibleWeb.Live.GoalSettings) + {:ok, lv, _html} = live(conn, "/#{site.domain}/settings/goals") + lv |> element(~s/button[phx-click="add-goal"]/) |> render_click() + assert form_view = find_live_child(lv, "goals-form") + + if opts[:with_parent?] do + {lv, form_view} + else + form_view + end + end +end diff --git a/test/plausible_web/live/goal_settings_test.exs b/test/plausible_web/live/goal_settings_test.exs new file mode 100644 index 000000000..e90351ae0 --- /dev/null +++ b/test/plausible_web/live/goal_settings_test.exs @@ -0,0 +1,177 @@ +defmodule PlausibleWeb.Live.GoalSettingsTest do + use PlausibleWeb.ConnCase, async: true + import Phoenix.LiveViewTest + import Plausible.Test.Support.HTML + + describe "GET /:website/settings/goals" do + setup [:create_user, :log_in, :create_site] + + test "lists goals for the site and renders links", %{conn: conn, site: site} do + {:ok, [g1, g2, g3]} = setup_goals(site) + conn = get(conn, "/#{site.domain}/settings/goals") + + resp = html_response(conn, 200) + assert resp =~ "Define actions that you want your users to take" + assert resp =~ "compose goals into funnels" + assert resp =~ "/#{site.domain}/settings/funnels" + assert element_exists?(resp, ~s|a[href="https://plausible.io/docs/goal-conversions"]|) + + assert resp =~ to_string(g1) + assert resp =~ "Pageview" + assert resp =~ to_string(g2) + assert resp =~ "Custom Event" + assert resp =~ to_string(g3) + assert resp =~ "Revenue Goal: EUR" + end + + test "lists goals with delete actions", %{conn: conn, site: site} do + {:ok, goals} = setup_goals(site) + conn = get(conn, "/#{site.domain}/settings/goals") + resp = html_response(conn, 200) + + for g <- goals do + assert element_exists?( + resp, + ~s/button[phx-click="delete-goal"][phx-value-goal-id=#{g.id}]#delete-goal-#{g.id}/ + ) + end + end + + test "if no goals are present, a proper info is displayed", %{conn: conn, site: site} do + conn = get(conn, "/#{site.domain}/settings/goals") + resp = html_response(conn, 200) + assert resp =~ "No goals configured for this site" + end + + test "if goals are present, no info about missing goals is displayed", %{ + conn: conn, + site: site + } do + {:ok, _goals} = setup_goals(site) + conn = get(conn, "/#{site.domain}/settings/goals") + resp = html_response(conn, 200) + refute resp =~ "No goals configured for this site" + end + + test "add goal button is rendered", %{conn: conn, site: site} do + conn = get(conn, "/#{site.domain}/settings/goals") + resp = html_response(conn, 200) + assert element_exists?(resp, ~s/button[phx-click="add-goal"]/) + end + + test "search goals input is rendered", %{conn: conn, site: site} do + conn = get(conn, "/#{site.domain}/settings/goals") + resp = html_response(conn, 200) + assert element_exists?(resp, ~s/input[type="text"]#filter-text/) + assert element_exists?(resp, ~s/form[phx-change="filter"]#filter-form/) + end + end + + describe "GoalSettings live view" do + setup [:create_user, :log_in, :create_site] + + test "allows goal deletion", %{conn: conn, site: site} do + {:ok, [g1, g2 | _]} = setup_goals(site) + {lv, html} = get_liveview(conn, site, with_html?: true) + + assert html =~ to_string(g1) + assert html =~ to_string(g2) + + html = lv |> element(~s/button#delete-goal-#{g1.id}/) |> render_click() + + refute html =~ to_string(g1) + assert html =~ to_string(g2) + + html = get(conn, "/#{site.domain}/settings/goals") |> html_response(200) + + refute html =~ to_string(g1) + assert html =~ to_string(g2) + end + + test "allows list filtering / search", %{conn: conn, site: site} do + {:ok, [g1, g2, g3]} = setup_goals(site) + {lv, html} = get_liveview(conn, site, with_html?: true) + + assert html =~ to_string(g1) + assert html =~ to_string(g2) + assert html =~ to_string(g3) + + html = type_into_search(lv, to_string(g3)) + + refute html =~ to_string(g1) + refute html =~ to_string(g2) + assert html =~ to_string(g3) + end + + test "allows resetting filter text via backspace icon", %{conn: conn, site: site} do + {:ok, [g1, g2, g3]} = setup_goals(site) + {lv, html} = get_liveview(conn, site, with_html?: true) + + refute element_exists?(html, ~s/svg[phx-click="reset-filter-text"]#reset-filter/) + + html = type_into_search(lv, to_string(g3)) + + assert element_exists?(html, ~s/svg[phx-click="reset-filter-text"]#reset-filter/) + + html = lv |> element(~s/svg#reset-filter/) |> render_click() + + assert html =~ to_string(g1) + assert html =~ to_string(g2) + assert html =~ to_string(g3) + end + + test "allows resetting filter text via no match link", %{conn: conn, site: site} do + {:ok, _goals} = setup_goals(site) + lv = get_liveview(conn, site) + html = type_into_search(lv, "Definitely this is not going to render any matches") + + assert html =~ "No goals found for this site. Please refine or" + assert html =~ "reset your search" + + assert element_exists?(html, ~s/a[phx-click="reset-filter-text"]#reset-filter-hint/) + html = lv |> element(~s/a#reset-filter-hint/) |> render_click() + + refute html =~ "No goals found for this site. Please refine or" + end + + test "clicking Add Goal button renders the form view", %{conn: conn, site: site} do + {:ok, _goals} = setup_goals(site) + lv = get_liveview(conn, site) + html = lv |> element(~s/button[phx-click="add-goal"]/) |> render_click() + + assert html =~ "Add goal for #{site.domain}" + + assert element_exists?( + html, + ~s/div#goals-form form[phx-submit="save-goal"][phx-click-away="cancel-add-goal"]/ + ) + end + end + + defp setup_goals(site) do + {:ok, g1} = Plausible.Goals.create(site, %{"page_path" => "/go/to/blog/**"}) + {:ok, g2} = Plausible.Goals.create(site, %{"event_name" => "Signup"}) + {:ok, g3} = Plausible.Goals.create(site, %{"event_name" => "Purchase", "currency" => "EUR"}) + {:ok, [g1, g2, g3]} + end + + defp get_liveview(conn, site, opts \\ []) do + conn = assign(conn, :live_module, PlausibleWeb.Live.GoalSettings) + {:ok, lv, html} = live(conn, "/#{site.domain}/settings/goals") + + if Keyword.get(opts, :with_html?) do + {lv, html} + else + lv + end + end + + defp type_into_search(lv, text) do + lv + |> element("form#filter-form") + |> render_change(%{ + "_target" => ["filter-text"], + "filter-text" => "#{text}" + }) + end +end