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 %>
-
- <% end %>
-
-
- <%= if @site.conversions_enabled do %>
- <%= button(to: "/#{URI.encode_www_form(@site.domain)}/settings/features/disable/conversions", method: :put, class: "bg-indigo-600 relative inline-flex flex-shrink-0 h-6 w-11 border-2 border-transparent rounded-full cursor-pointer transition-colors ease-in-out duration-200 focus:outline-none focus:ring") do %>
-
- <% end %>
- <% else %>
- <%= button(to: "/#{URI.encode_www_form(@site.domain)}/settings/features/enable/conversions", method: :put, class: "bg-gray-200 dark:bg-gray-700 relative inline-flex flex-shrink-0 h-6 w-11 border-2 border-transparent rounded-full cursor-pointer transition-colors ease-in-out duration-200 focus:outline-none focus:ring") do %>
-
- <% end %>
- <% end %>
- Show goals in the dashboard
-
-
-
- <%= if @site.conversions_enabled do %>
- <%= if Enum.count(@goals) > 0 do %>
-
- <%= for goal <- @goals do %>
-
- <%= goal_name(goal) %>
- <%= 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_name(goal)}? This will just affect the UI, all of your analytics data will stay intact."]) do %>
-
- <% 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") %>
- <% end %>
-
diff --git a/lib/plausible_web/templates/site/settings_goals.html.heex b/lib/plausible_web/templates/site/settings_goals.html.heex
new file mode 100644
index 000000000..388eeae8e
--- /dev/null
+++ b/lib/plausible_web/templates/site/settings_goals.html.heex
@@ -0,0 +1,96 @@
+
+
+
Goals
+
+ 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 %>
+
+ <% end %>
+
+
+
+ <%= 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"
+ ) %>
+ <%= if Enum.count(@goals) >= Funnel.min_steps() 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/lib/plausible_web/views/layout_view.ex b/lib/plausible_web/views/layout_view.ex
index 1e6e04927..e81c35d29 100644
--- a/lib/plausible_web/views/layout_view.ex
+++ b/lib/plausible_web/views/layout_view.ex
@@ -23,17 +23,16 @@ defmodule PlausibleWeb.LayoutView do
[key: "People", value: "people"],
[key: "Visibility", value: "visibility"],
[key: "Goals", value: "goals"],
+ if Plausible.Funnels.enabled_for?(conn.assigns[:current_user]) do
+ [key: "Funnels", value: "funnels"]
+ end,
[key: "Search Console", value: "search-console"],
[key: "Email reports", value: "email-reports"],
if !is_selfhost() && conn.assigns[:site].custom_domain do
[key: "Custom domain", value: "custom-domain"]
- else
- nil
end,
if conn.assigns[:current_user_role] == :owner do
[key: "Danger zone", value: "danger-zone"]
- else
- nil
end
]
end
diff --git a/lib/plausible_web/views/site_view.ex b/lib/plausible_web/views/site_view.ex
index 7086fe730..535886650 100644
--- a/lib/plausible_web/views/site_view.ex
+++ b/lib/plausible_web/views/site_view.ex
@@ -1,6 +1,7 @@
defmodule PlausibleWeb.SiteView do
use PlausibleWeb, :view
import Phoenix.Pagination.HTML
+ use Plausible.Funnel
def plausible_url do
PlausibleWeb.Endpoint.url()
diff --git a/test/plausible_web/controllers/error_report_controller_test.exs b/test/plausible_web/controllers/error_report_controller_test.exs
index fd97957d2..3af101c7d 100644
--- a/test/plausible_web/controllers/error_report_controller_test.exs
+++ b/test/plausible_web/controllers/error_report_controller_test.exs
@@ -3,6 +3,7 @@ defmodule PlausibleWeb.ErrorReportControllerTest do
use Bamboo.Test
import Phoenix.View
+ import Plausible.Test.Support.HTML
alias PlausibleWeb.Endpoint
alias PlausibleWeb.ErrorView
@@ -144,25 +145,4 @@ defmodule PlausibleWeb.ErrorReportControllerTest do
end
end
end
-
- defp form_exists?(html, action_path) do
- element_exists?(html, "form[action=\"" <> action_path <> "\"]")
- end
-
- defp element_exists?(html, selector) do
- html
- |> find(selector)
- |> Enum.empty?()
- |> Kernel.not()
- end
-
- defp submit_button(html, form) do
- find(html, "#{form} button[type=\"submit\"]")
- end
-
- defp find(html, value) do
- html
- |> Floki.parse_document!()
- |> Floki.find(value)
- end
end
diff --git a/test/plausible_web/controllers/site_controller_test.exs b/test/plausible_web/controllers/site_controller_test.exs
index bd8075ade..8bb850e0a 100644
--- a/test/plausible_web/controllers/site_controller_test.exs
+++ b/test/plausible_web/controllers/site_controller_test.exs
@@ -346,6 +346,16 @@ defmodule PlausibleWeb.SiteControllerTest do
assert html_response(conn, 200) =~ "Custom event"
assert html_response(conn, 200) =~ "Visit /register"
end
+
+ test "goal names are HTML safe", %{conn: conn, site: site} do
+ insert(:goal, site: site, event_name: "")
+
+ conn = get(conn, "/#{site.domain}/settings/goals")
+
+ resp = html_response(conn, 200)
+ assert resp =~ "<some_event>"
+ refute resp =~ ""
+ end
end
describe "PUT /:website/settings" do
@@ -739,106 +749,99 @@ defmodule PlausibleWeb.SiteControllerTest do
end
end
- describe "PUT /:website/settings/features/:action/:feature" do
- setup [:create_user, :log_in]
-
- test "can disable conversions, funnels, and props with admin access", %{
- conn: conn,
- user: user
- } do
- site = insert(:site)
- insert(:site_membership, user: user, site: site, role: :admin)
-
- conn1 = put(conn, "/#{site.domain}/settings/features/disable/conversions")
- conn2 = put(conn, "/#{site.domain}/settings/features/disable/funnels")
- conn3 = put(conn, "/#{site.domain}/settings/features/disable/props")
-
- assert %{conversions_enabled: false, funnels_enabled: false, props_enabled: false} =
- Plausible.Sites.get_by_domain(site.domain)
-
- assert Phoenix.Flash.get(conn1.assigns.flash, :success) ==
- "Goals are now hidden from your dashboard"
-
- assert Phoenix.Flash.get(conn2.assigns.flash, :success) ==
- "Funnels are now hidden from your dashboard"
-
- assert Phoenix.Flash.get(conn3.assigns.flash, :success) ==
- "Properties are now hidden from your dashboard"
-
- assert redirected_to(conn1, 302) =~ "/#{site.domain}/settings/goals"
+ describe "PUT /:website/settings/features/visibility/:setting" do
+ def build_conn_with_some_url(context) do
+ {:ok, Map.put(context, :conn, build_conn(:get, "/some_parent_path"))}
end
- test "can enable conversions, funnels, and props with admin access", %{
- conn: conn,
- user: user
- } do
- site =
- insert(:site, conversions_enabled: false, funnels_enabled: false, props_enabled: false)
+ setup [:build_conn_with_some_url, :create_user, :log_in]
- insert(:site_membership, user: user, site: site, role: :owner)
+ for {title, setting} <- %{
+ "Goals" => :conversions_enabled,
+ "Funnels" => :funnels_enabled,
+ "Properties" => :props_enabled
+ } do
+ test "can toggle #{title} with admin access", %{
+ user: user,
+ conn: conn0
+ } do
+ site = insert(:site)
+ insert(:site_membership, user: user, site: site, role: :admin)
- conn1 = put(conn, "/#{site.domain}/settings/features/enable/conversions")
- conn2 = put(conn, "/#{site.domain}/settings/features/enable/funnels")
- conn3 = put(conn, "/#{site.domain}/settings/features/enable/props")
+ conn =
+ put(
+ conn0,
+ PlausibleWeb.Components.Site.Feature.target(site, unquote(setting), conn0, false)
+ )
- assert %{conversions_enabled: true, funnels_enabled: true, props_enabled: true} =
- Plausible.Sites.get_by_domain(site.domain)
+ assert Phoenix.Flash.get(conn.assigns.flash, :success) ==
+ "#{unquote(title)} are now hidden from your dashboard"
- assert Phoenix.Flash.get(conn1.assigns.flash, :success) ==
- "Goals are now visible again on your dashboard"
+ assert redirected_to(conn, 302) =~ "/some_parent_path"
- assert Phoenix.Flash.get(conn2.assigns.flash, :success) ==
- "Funnels are now visible again on your dashboard"
+ assert %{unquote(setting) => false} = Plausible.Sites.get_by_domain(site.domain)
- assert Phoenix.Flash.get(conn3.assigns.flash, :success) ==
- "Properties are now visible again on your dashboard"
+ conn =
+ put(
+ conn0,
+ PlausibleWeb.Components.Site.Feature.target(site, unquote(setting), conn0, true)
+ )
- assert redirected_to(conn3, 302) =~ "/#{site.domain}/settings/goals"
- end
-
- test "can enable and disable with super-admin access", %{
- conn: conn,
- user: user
- } do
- site = insert(:site)
- patch_env(:super_admin_user_ids, [user.id])
+ assert Phoenix.Flash.get(conn.assigns.flash, :success) ==
+ "#{unquote(title)} are now visible again on your dashboard"
- conn1 = put(conn, "/#{site.domain}/settings/features/disable/funnels")
- assert %{funnels_enabled: false} = Plausible.Sites.get_by_domain(site.domain)
+ assert redirected_to(conn, 302) =~ "/some_parent_path"
- assert Phoenix.Flash.get(conn1.assigns.flash, :success) ==
- "Funnels are now hidden from your dashboard"
+ assert %{unquote(setting) => true} = Plausible.Sites.get_by_domain(site.domain)
+ end
+ end
- conn2 = put(conn, "/#{site.domain}/settings/features/enable/funnels")
- assert %{funnels_enabled: true} = Plausible.Sites.get_by_domain(site.domain)
+ for {title, setting} <- %{
+ "Goals" => :conversions_enabled,
+ "Funnels" => :funnels_enabled,
+ "Properties" => :props_enabled
+ } do
+ test "cannot toggle #{title} with viewer access", %{
+ user: user,
+ conn: conn0
+ } do
+ site = insert(:site)
+ insert(:site_membership, user: user, site: site, role: :viewer)
- assert Phoenix.Flash.get(conn2.assigns.flash, :success) ==
- "Funnels are now visible again on your dashboard"
+ conn =
+ put(
+ conn0,
+ PlausibleWeb.Components.Site.Feature.target(site, unquote(setting), conn0, false)
+ )
- assert redirected_to(conn1, 302) =~ "/#{site.domain}/settings/goals"
- assert redirected_to(conn2, 302) =~ "/#{site.domain}/settings/goals"
+ assert conn.status == 404
+ assert conn.halted
+ end
end
- test "fails to set feature status with viewer access", %{
- conn: conn,
- user: user
- } do
+ test "setting feature visibility is idempotent", %{user: user, conn: conn0} do
site = insert(:site)
- insert(:site_membership, user: user, site: site, role: :viewer)
+ insert(:site_membership, user: user, site: site, role: :admin)
- conn = put(conn, "/#{site.domain}/settings/features/disable/conversions")
+ setting = :funnels_enabled
- assert %{conversions_enabled: true} = Plausible.Sites.get_by_domain(site.domain)
- assert conn.status == 404
- end
+ conn =
+ put(
+ conn0,
+ PlausibleWeb.Components.Site.Feature.target(site, setting, conn0, false)
+ )
- test "fails to set feature status for a foreign site", %{conn: conn} do
- site = insert(:site)
+ assert %{^setting => false} = Plausible.Sites.get_by_domain(site.domain)
+ assert redirected_to(conn, 302) =~ "/some_parent_path"
- conn = put(conn, "/#{site.domain}/settings/features/disable/conversions")
+ conn =
+ put(
+ conn0,
+ PlausibleWeb.Components.Site.Feature.target(site, setting, conn0, false)
+ )
- assert %{conversions_enabled: true} = Plausible.Sites.get_by_domain(site.domain)
- assert conn.status == 404
+ assert %{^setting => false} = Plausible.Sites.get_by_domain(site.domain)
+ assert redirected_to(conn, 302) =~ "/some_parent_path"
end
end
@@ -1301,7 +1304,10 @@ defmodule PlausibleWeb.SiteControllerTest do
delete(conn, "/#{site.domain}/settings/forget-imported")
- assert Plausible.Stats.Clickhouse.imported_pageview_count(site) == 0
+ assert eventually(fn ->
+ count = Plausible.Stats.Clickhouse.imported_pageview_count(site)
+ {count == 0, count}
+ end)
end
test "cancels Oban job if it exists", %{conn: conn, site: site} do
diff --git a/test/plausible_web/live/funnel_settings/funnel_settings/combo_box_test.exs b/test/plausible_web/live/funnel_settings/funnel_settings/combo_box_test.exs
new file mode 100644
index 000000000..086b772ea
--- /dev/null
+++ b/test/plausible_web/live/funnel_settings/funnel_settings/combo_box_test.exs
@@ -0,0 +1,270 @@
+defmodule PlausibleWeb.Live.FunnelSettings.ComboBoxTest do
+ use PlausibleWeb.ConnCase, async: true
+ import Phoenix.LiveViewTest
+ import Plausible.Test.Support.HTML
+
+ alias PlausibleWeb.Live.FunnelSettings.ComboBox
+
+ @ul "ul#dropdown-test-component[x-show=isOpen][x-ref=suggestions]"
+
+ defp suggestion_li(idx) do
+ ~s/#{@ul} li#dropdown-test-component-option-#{idx - 1}/
+ end
+
+ describe "static rendering" do
+ test "renders suggestions" do
+ assert doc = render_sample_component(new_options(10))
+
+ assert element_exists?(
+ doc,
+ ~s/input#test-component[name="display-test-component"][phx-change="search"]/
+ )
+
+ assert element_exists?(doc, @ul)
+
+ for i <- 1..10 do
+ assert element_exists?(doc, suggestion_li(i))
+ end
+ end
+
+ test "renders up to 15 suggestions by default" do
+ assert doc = render_sample_component(new_options(20))
+
+ assert element_exists?(doc, suggestion_li(14))
+ assert element_exists?(doc, suggestion_li(15))
+
+ refute element_exists?(doc, suggestion_li(16))
+ refute element_exists?(doc, suggestion_li(17))
+
+ assert Floki.text(doc) =~ "Max results reached"
+ end
+
+ test "Alpine.js: renders attrs focusing suggestion elements" do
+ assert doc = render_sample_component(new_options(10))
+ li1 = doc |> find(suggestion_li(1)) |> List.first()
+ li2 = doc |> find(suggestion_li(2)) |> List.first()
+
+ assert text_of_attr(li1, "@mouseenter") == "setFocus(0)"
+ assert text_of_attr(li2, "@mouseenter") == "setFocus(1)"
+
+ assert text_of_attr(li1, "x-bind:class") =~ "focus === 0"
+ assert text_of_attr(li2, "x-bind:class") =~ "focus === 1"
+ end
+
+ test "Alpine.js: component refers to window.suggestionsDropdown" do
+ assert new_options(2)
+ |> render_sample_component()
+ |> find("div#input-picker-main-test-component")
+ |> text_of_attr("x-data") =~ "window.suggestionsDropdown('test-component')"
+ end
+
+ test "Alpine.js: component sets up keyboard navigation" do
+ main =
+ new_options(2)
+ |> render_sample_component()
+ |> find("div#input-picker-main-test-component")
+
+ assert text_of_attr(main, "x-on:keydown.arrow-up") == "focusPrev"
+ assert text_of_attr(main, "x-on:keydown.arrow-down") == "focusNext"
+ assert text_of_attr(main, "x-on:keydown.enter") == "select()"
+ end
+
+ test "Alpine.js: component sets up close on click-away" do
+ assert new_options(2)
+ |> render_sample_component()
+ |> find("div#input-picker-main-test-component div div")
+ |> text_of_attr("@click.away") == "close"
+ end
+
+ test "Alpine.js: component sets up open on focusing the display input" do
+ assert new_options(2)
+ |> render_sample_component()
+ |> find("input#test-component")
+ |> text_of_attr("x-on:focus") == "open"
+ end
+
+ test "Alpine.js: dropdown is annotated and shows when isOpen is true" do
+ dropdown =
+ new_options(2)
+ |> render_sample_component()
+ |> find("#dropdown-test-component")
+
+ assert text_of_attr(dropdown, "x-show") == "isOpen"
+ assert text_of_attr(dropdown, "x-ref") == "suggestions"
+ end
+
+ test "Dropdown shows a notice when no suggestions exist" do
+ doc = render_sample_component([])
+
+ assert text_of_element(doc, "#dropdown-test-component") ==
+ "No matches found. Try searching for something different."
+ end
+ end
+
+ describe "autosuggest algorithm" do
+ test "favours exact match" do
+ options = fake_options(["yellow", "hello", "cruel hello world"])
+
+ assert [{_, "hello"}, {_, "cruel hello world"}, {_, "yellow"}] =
+ ComboBox.suggest("hello", options)
+ end
+
+ test "skips entries shorter than input" do
+ options = fake_options(["yellow", "hello", "cruel hello world"])
+
+ assert [{_, "cruel hello world"}] = ComboBox.suggest("cruel hello", options)
+ end
+
+ test "favours similiarity" do
+ options = fake_options(["melon", "hello", "yellow"])
+ assert [{_, "hello"}, {_, "yellow"}, {_, "melon"}] = ComboBox.suggest("hell", options)
+ end
+
+ test "allows fuzzy matching" do
+ options = fake_options(["/url/0xC0FFEE", "/url/0xDEADBEEF", "/url/other"])
+
+ assert [{_, "/url/0xC0FFEE"}, {_, "/url/0xDEADBEEF"}, {_, "/url/other"}] =
+ ComboBox.suggest("0x FF", options)
+ end
+
+ test "suggests up to 15 entries" do
+ options =
+ 1..20
+ |> Enum.map(&"Option #{&1}")
+ |> fake_options()
+
+ suggestions = ComboBox.suggest("Option", options)
+ assert Enum.count(suggestions) == 15
+ end
+ end
+
+ describe "integration - live rendering" do
+ setup [:create_user, :log_in, :create_site]
+
+ test "search reacts to the input, the user types in", %{conn: conn, site: site} do
+ setup_goals(site, ["Hello World", "Plausible", "Another World"])
+ lv = get_liveview(conn, site)
+
+ doc = type_into_combo(lv, 1, "hello")
+
+ assert text_of_element(doc, "#dropdown-step-1-option-0") == "Hello World"
+
+ doc = type_into_combo(lv, 1, "plausible")
+
+ assert text_of_element(doc, "#dropdown-step-1-option-0") == "Plausible"
+ end
+
+ test "selecting an option prefills input values", %{conn: conn, site: site} do
+ {:ok, [_, _, g3]} = setup_goals(site, ["Hello World", "Plausible", "Another World"])
+ lv = get_liveview(conn, site)
+
+ doc = type_into_combo(lv, 1, "another")
+
+ refute element_exists?(doc, ~s/input[type="hidden"][value="#{g3.id}"]/)
+ refute element_exists?(doc, ~s/input[type="text"][value="Another World"]/)
+
+ lv
+ |> element("li#dropdown-step-1-option-0 a")
+ |> render_click()
+
+ assert lv
+ |> element("#submit-step-1")
+ |> render()
+ |> element_exists?(~s/input[type="hidden"][value="#{g3.id}"]/)
+
+ assert lv
+ |> element("#step-1")
+ |> render()
+ |> element_exists?(~s/input[type="text"][value="Another World"]/)
+ end
+
+ test "selecting one option reduces suggestions in the other", %{conn: conn, site: site} do
+ setup_goals(site, ["Hello World", "Plausible", "Another World"])
+ lv = get_liveview(conn, site)
+
+ type_into_combo(lv, 1, "another")
+
+ lv
+ |> element("li#dropdown-step-1-option-0 a")
+ |> render_click()
+
+ doc = type_into_combo(lv, 2, "another")
+
+ refute text_of_element(doc, "ul#dropdown-step-1 li") =~ "Another World"
+
+ assert text_of_element(doc, "ul#dropdown-step-2 li") =~ "Hello World"
+ assert text_of_element(doc, "ul#dropdown-step-2 li") =~ "Plausible"
+ refute text_of_element(doc, "ul#dropdown-step-2 li") =~ "Another World"
+ end
+
+ test "removing one option alters suggestions for other", %{conn: conn, site: site} do
+ setup_goals(site, ["Hello World", "Plausible", "Another World"])
+
+ lv = get_liveview(conn, site)
+
+ lv |> element(~s/a[phx-click="add-step"]/) |> render_click()
+
+ type_into_combo(lv, 2, "hello")
+
+ lv
+ |> element("li#dropdown-step-2-option-0 a")
+ |> render_click()
+
+ doc = type_into_combo(lv, 1, "hello")
+
+ refute text_of_element(doc, "ul#dropdown-step-1 li") =~ "Hello World"
+
+ lv |> element(~s/#remove-step-2/) |> render_click()
+
+ doc = type_into_combo(lv, 1, "hello")
+
+ assert text_of_element(doc, "ul#dropdown-step-1 li") =~ "Hello World"
+ end
+ end
+
+ defp render_sample_component(options) do
+ render_component(ComboBox,
+ options: options,
+ submit_name: "test-submit-name",
+ id: "test-component"
+ )
+ end
+
+ defp new_options(n) do
+ Enum.map(1..n, &{&1, "TestOption #{&1}"})
+ end
+
+ defp get_liveview(conn, site) do
+ conn = assign(conn, :live_module, PlausibleWeb.Live.FunnelSettings)
+ {:ok, lv, _html} = live(conn, "/#{site.domain}/settings/funnels")
+ lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
+ assert form_view = find_live_child(lv, "funnels-form")
+ form_view |> element("form") |> render_change(%{funnel: %{name: "My test funnel"}})
+ form_view
+ end
+
+ defp setup_goals(site, goal_names) when is_list(goal_names) do
+ goals =
+ Enum.map(goal_names, fn goal_name ->
+ {:ok, g} = Plausible.Goals.create(site, %{"event_name" => goal_name})
+ g
+ end)
+
+ {:ok, goals}
+ end
+
+ defp fake_options(option_names) do
+ option_names
+ |> Enum.shuffle()
+ |> Enum.with_index(fn element, index -> {index, element} end)
+ end
+
+ defp type_into_combo(lv, idx, text) do
+ lv
+ |> element("input#step-#{idx}")
+ |> render_change(%{
+ "_target" => ["display-step-#{idx}"],
+ "display-step-#{idx}" => "#{text}"
+ })
+ end
+end
diff --git a/test/plausible_web/live/funnel_settings/funnel_settings_test.exs b/test/plausible_web/live/funnel_settings/funnel_settings_test.exs
new file mode 100644
index 000000000..8771f6278
--- /dev/null
+++ b/test/plausible_web/live/funnel_settings/funnel_settings_test.exs
@@ -0,0 +1,212 @@
+defmodule PlausibleWeb.Live.FunnelSettingsTest do
+ use PlausibleWeb.ConnCase, async: true
+ import Phoenix.LiveViewTest
+ import Plausible.Test.Support.HTML
+
+ describe "GET /:website/settings/funnels" do
+ setup [:create_user, :log_in, :create_site]
+
+ test "lists funnels for the site and renders help link", %{conn: conn, site: site} do
+ :ok = setup_funnels(site)
+ conn = get(conn, "/#{site.domain}/settings/funnels")
+
+ resp = html_response(conn, 200)
+ assert resp =~ "Compose goals into funnels"
+ assert resp =~ "From blog to signup"
+ assert resp =~ "From signup to blog"
+ assert element_exists?(resp, "a[href=\"https://plausible.io/docs/funnel-analysis\"]")
+ end
+
+ test "if goals are present, Add Funnel button is rendered", %{conn: conn, site: site} do
+ :ok = setup_funnels(site)
+ conn = get(conn, "/#{site.domain}/settings/funnels")
+ resp = conn |> html_response(200)
+ assert element_exists?(resp, ~S/button[phx-click="add-funnel"]/)
+ end
+
+ test "if not enough goals are present, a hint to create goals is rendered", %{
+ conn: conn,
+ site: site
+ } do
+ {:ok, _} = Plausible.Goals.create(site, %{"page_path" => "/go/to/blog/**"})
+ conn = get(conn, "/#{site.domain}/settings/funnels")
+
+ doc = conn |> html_response(200)
+ assert Floki.text(doc) =~ "You need to define at least two goals to create a funnel."
+
+ add_goals_path = Routes.site_path(conn, :new_goal, site.domain)
+ assert element_exists?(doc, ~s/a[href="#{add_goals_path}"]/)
+ end
+ end
+
+ describe "FunnelSettings component" do
+ setup [:create_user, :log_in, :create_site]
+
+ test "renders the funnel form on clicking 'Add Funnel' button", %{conn: conn, site: site} do
+ setup_goals(site)
+ lv = get_liveview(conn, site)
+ doc = render_click(lv, "add-funnel")
+
+ assert element_exists?(doc, ~s/form[phx-change="validate"][phx-submit="save"]/)
+ assert element_exists?(doc, ~s/form input[type="text"][name="funnel[name]"]/)
+
+ assert element_exists?(
+ doc,
+ ~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-1/
+ )
+
+ step_setup_controls = [
+ ~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-1/,
+ ~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-2/,
+ ~s/input[type="text"][name="display-step-1"]#step-1/,
+ ~s/input[type="text"][name="display-step-2"]#step-2/,
+ ~s/a[phx-click="add-step"]/
+ ]
+
+ Enum.each(step_setup_controls, &assert(element_exists?(doc, &1)))
+ end
+
+ test "clicking 'Add another step' adds a pair of inputs and renders remove step buttons", %{
+ conn: conn,
+ site: site
+ } do
+ setup_goals(site)
+ lv = get_liveview(conn, site)
+
+ lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
+
+ assert lv = find_live_child(lv, "funnels-form")
+ lv |> element("form") |> render_change(%{funnel: %{name: "My test funnel"}})
+ doc = lv |> element(~s/a[phx-click="add-step"]/) |> render_click()
+
+ assert element_exists?(
+ doc,
+ ~s/input[type="hidden"][name="funnel[steps][][goal_id]"]#submit-step-3/
+ )
+
+ assert element_exists?(doc, ~s/input[type="text"][name="display-step-1"]#step-1/)
+
+ assert element_exists?(
+ doc,
+ ~s/svg#remove-step-1[phx-click="remove-step"][phx-value-step-idx="1"]/
+ )
+
+ assert element_exists?(
+ doc,
+ ~s/svg#remove-step-2[phx-click="remove-step"][phx-value-step-idx="2"]/
+ )
+
+ assert element_exists?(
+ doc,
+ ~s/svg#remove-step-3[phx-click="remove-step"][phx-value-step-idx="3"]/
+ )
+ end
+
+ test "clicking the 'remove step' button removes a step", %{site: site, conn: conn} do
+ setup_goals(site)
+ lv = get_liveview(conn, site)
+
+ lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
+ assert lv = find_live_child(lv, "funnels-form")
+ lv |> element("form") |> render_change(%{funnel: %{name: "My test funnel"}})
+ lv |> element(~s/a[phx-click="add-step"]/) |> render_click()
+
+ doc = lv |> element(~s/#remove-step-2/) |> render_click()
+
+ assert element_exists?(doc, ~s/input#step-1/)
+ assert element_exists?(doc, ~s/input#step-3/)
+ refute element_exists?(doc, ~s/input#step-2/)
+ end
+
+ test "save button becomes active once at least two steps are selected", %{
+ conn: conn,
+ site: site
+ } do
+ setup_goals(site)
+ lv = get_liveview(conn, site)
+ lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
+
+ assert lv = find_live_child(lv, "funnels-form")
+
+ doc =
+ lv
+ |> element("form")
+ |> render_change(%{funnel: %{name: "My test funnel"}})
+
+ save_inactive = ~s/form button#save.cursor-not-allowed/
+ save_active = ~s/form button#save[type="submit"]/
+
+ refute element_exists?(doc, save_active)
+ assert element_exists?(doc, save_inactive)
+
+ doc =
+ lv
+ |> element("form")
+ |> render_change(%{
+ funnel: %{
+ name: "My test funnel",
+ steps: [
+ %{goal_id: 1},
+ %{goal_id: 2}
+ ]
+ }
+ })
+
+ assert element_exists?(doc, save_active)
+ refute element_exists?(doc, save_inactive)
+ end
+
+ test "cancel buttons renders the funnel list", %{
+ conn: conn,
+ site: site
+ } do
+ setup_goals(site)
+ lv = get_liveview(conn, site)
+ doc = lv |> element(~s/button[phx-click="add-funnel"]/) |> render_click()
+
+ cancel_button = ~s/button#cancel[phx-click="cancel-add-funnel"]/
+
+ assert element_exists?(doc, cancel_button)
+
+ doc =
+ lv
+ |> element(cancel_button)
+ |> render_click()
+
+ assert doc =~ "No funnels configured for this site yet"
+ assert element_exists?(doc, ~S/button[phx-click="add-funnel"]/)
+ end
+ end
+
+ defp setup_funnels(site) do
+ {:ok, [g1, g2]} = setup_goals(site)
+
+ {:ok, _} =
+ Plausible.Funnels.create(
+ site,
+ "From blog to signup",
+ [%{"goal_id" => g1.id}, %{"goal_id" => g2.id}]
+ )
+
+ {:ok, _} =
+ Plausible.Funnels.create(
+ site,
+ "From signup to blog",
+ [%{"goal_id" => g2.id}, %{"goal_id" => g1.id}]
+ )
+
+ :ok
+ 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, [g1, g2]}
+ end
+
+ defp get_liveview(conn, site) do
+ conn = assign(conn, :live_module, PlausibleWeb.Live.FunnelSettings)
+ {:ok, lv, _html} = live(conn, "/#{site.domain}/settings/funnels")
+ lv
+ end
+end
diff --git a/test/support/html.ex b/test/support/html.ex
new file mode 100644
index 000000000..4623eb7b1
--- /dev/null
+++ b/test/support/html.ex
@@ -0,0 +1,40 @@
+defmodule Plausible.Test.Support.HTML do
+ @moduledoc """
+ Floki wrappers to help make assertions about HTML/DOM structures
+ """
+
+ def element_exists?(html, selector) do
+ html
+ |> find(selector)
+ |> Enum.empty?()
+ |> Kernel.not()
+ end
+
+ def find(html, value) do
+ html
+ |> Floki.parse_document!()
+ |> Floki.find(value)
+ end
+
+ def submit_button(html, form) do
+ find(html, "#{form} button[type=\"submit\"]")
+ end
+
+ def form_exists?(html, action_path) do
+ element_exists?(html, "form[action=\"" <> action_path <> "\"]")
+ end
+
+ def text_of_element(html, element) do
+ html
+ |> find(element)
+ |> Floki.text()
+ |> String.trim()
+ end
+
+ def text_of_attr(element, attr) do
+ element
+ |> Floki.attribute(attr)
+ |> Floki.text()
+ |> String.trim()
+ end
+end
diff --git a/test/test_helper.exs b/test/test_helper.exs
index d385c3cd7..9cfb56d15 100644
--- a/test/test_helper.exs
+++ b/test/test_helper.exs
@@ -2,5 +2,6 @@
Mox.defmock(Plausible.HTTPClient.Mock, for: Plausible.HTTPClient.Interface)
Application.ensure_all_started(:double)
FunWithFlags.enable(:revenue_goals)
+FunWithFlags.enable(:funnels)
Ecto.Adapters.SQL.Sandbox.mode(Plausible.Repo, :manual)
ExUnit.configure(exclude: [:slow])