+ """
+ 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.
+
+ 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.
+
+
+ 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.
+
<%= 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