diff --git a/.formatter.exs b/.formatter.exs index a78aed3cf..ae3e2f89e 100644 --- a/.formatter.exs +++ b/.formatter.exs @@ -1,4 +1,5 @@ [ + plugins: [Phoenix.LiveView.HTMLFormatter], import_deps: [:ecto, :ecto_sql, :phoenix], subdirectories: ["priv/*/migrations"], inputs: ["*.{heex,ex,exs}", "{config,lib,test}/**/*.{heex,ex,exs}", "priv/*/seeds.exs"] diff --git a/.github/workflows/elixir.yml b/.github/workflows/elixir.yml index dd77fbb90..1393778dd 100644 --- a/.github/workflows/elixir.yml +++ b/.github/workflows/elixir.yml @@ -58,8 +58,8 @@ jobs: deps _build priv/plts - key: ${{ runner.os }}-mix-v4-${{ hashFiles('**/mix.lock') }} - restore-keys: ${{ runner.os }}-mix-v4- + key: ${{ runner.os }}-mix-v5-${{ hashFiles('**/mix.lock') }} + restore-keys: ${{ runner.os }}-mix-v5- - name: Install dependencies run: mix deps.get && npm install --prefix ./tracker - name: Check Formatting diff --git a/assets/js/app.js b/assets/js/app.js index 9c2bb174d..a5762bd8e 100644 --- a/assets/js/app.js +++ b/assets/js/app.js @@ -2,8 +2,10 @@ import "../css/app.css" import "flatpickr/dist/flatpickr.min.css" import "./polyfills/closest" import 'abortcontroller-polyfill/dist/polyfill-patch-fetch' -import "phoenix_html" import 'alpinejs' +import "./liveview/live_socket" +import "./liveview/suggestions_dropdown" +import "./liveview/phx_events" const triggers = document.querySelectorAll('[data-dropdown-trigger]') @@ -49,7 +51,7 @@ if (registerForm) { } } /* eslint-disable-next-line no-undef */ - plausible('Signup', {callback: submitForm}); + plausible('Signup', { callback: submitForm }); }) } @@ -58,12 +60,12 @@ const changelogNotification = document.getElementById('changelog-notification') if (changelogNotification) { showChangelogNotification(changelogNotification) - fetch('https://plausible.io/changes.txt', {headers: {'Content-Type': 'text/plain'}}) + fetch('https://plausible.io/changes.txt', { headers: { 'Content-Type': 'text/plain' } }) .then((res) => res.text()) .then((res) => { localStorage.lastChangelogUpdate = new Date(res).getTime() showChangelogNotification(changelogNotification) - }) + }) } function showChangelogNotification(el) { @@ -71,7 +73,7 @@ function showChangelogNotification(el) { const lastChecked = Number(localStorage.lastChangelogClick) const hasNewUpdateSinceLastClicked = lastUpdated > lastChecked - const notOlderThanThreeDays = Date.now() - lastUpdated < 1000 * 60 * 60 * 72 + const notOlderThanThreeDays = Date.now() - lastUpdated < 1000 * 60 * 60 * 72 if ((!lastChecked || hasNewUpdateSinceLastClicked) && notOlderThanThreeDays) { el.innerHTML = ` diff --git a/assets/js/liveview/live_socket.js b/assets/js/liveview/live_socket.js new file mode 100644 index 000000000..b83099922 --- /dev/null +++ b/assets/js/liveview/live_socket.js @@ -0,0 +1,18 @@ +import "phoenix_html" +import { Socket } from "phoenix" +import { LiveSocket } from "phoenix_live_view" + +let csrfToken = document.querySelector("meta[name='csrf-token']").getAttribute("content") +let liveSocket = new LiveSocket("/live", Socket, { + params: { _csrf_token: csrfToken }, hooks: {}, dom: { + // for alpinejs integration + onBeforeElUpdated(from, to) { + if (from.__x) { + window.Alpine.clone(from.__x, to); + } + }, + } +}) + +liveSocket.connect() +window.liveSocket = liveSocket diff --git a/assets/js/liveview/phx_events.js b/assets/js/liveview/phx_events.js new file mode 100644 index 000000000..c36abf3fe --- /dev/null +++ b/assets/js/liveview/phx_events.js @@ -0,0 +1,7 @@ +window.addEventListener(`phx:update-value`, (e) => { + let el = document.getElementById(e.detail.id) + el.value = e.detail.value + if (e.detail.fire) { + el.dispatchEvent(new Event("input", { bubbles: true })) + } +}) diff --git a/assets/js/liveview/suggestions_dropdown.js b/assets/js/liveview/suggestions_dropdown.js new file mode 100644 index 000000000..a3c724e96 --- /dev/null +++ b/assets/js/liveview/suggestions_dropdown.js @@ -0,0 +1,40 @@ +// Courtesy of Benjamin von Polheim: +// https://blog.devgenius.io/build-a-performat-autocomplete-using-phoenix-liveview-and-alpine-js-8bcbbed17ba7 +let suggestionsDropdown = function(id) { + return { + isOpen: false, + id: id, + open() { this.isOpen = true }, + close() { this.isOpen = false }, + focus: 0, + setFocus(f) { + this.focus = f; + }, + select() { + this.$refs[`dropdown-${this.id}-option-${this.focus}`]?.click() + this.focusPrev() + }, + scrollTo(idx) { + this.$refs[`dropdown-${this.id}-option-${idx}`]?.scrollIntoView( + { block: 'center', behavior: 'smooth', inline: 'start' } + ) + }, + focusNext() { + const nextIndex = this.focus + 1 + const total = this.$refs.suggestions?.childElementCount ?? 0 + if (this.isOpen && nextIndex < total) { + this.setFocus(nextIndex) + this.scrollTo(nextIndex); + } + }, + focusPrev() { + const nextIndex = this.focus - 1 + if (this.isOpen && nextIndex >= 0) { + this.setFocus(nextIndex) + this.scrollTo(nextIndex) + } + }, + } +} + +window.suggestionsDropdown = suggestionsDropdown diff --git a/assets/tailwind.config.js b/assets/tailwind.config.js index 83ae7fcb7..76611faf2 100644 --- a/assets/tailwind.config.js +++ b/assets/tailwind.config.js @@ -5,6 +5,9 @@ module.exports = { content: [ './js/**/*.js', '../lib/plausible_web/templates/**/*.html.eex', + '../lib/plausible_web/templates/**/*.html.heex', + '../lib/plausible_web/live/**/*.ex', + '../lib/plausible_web/components/**/*.ex', ], safelist: [ // PlausibleWeb.StatsView.stats_container_class/1 uses this class diff --git a/config/config.exs b/config/config.exs index b4689c9c8..f226f62eb 100644 --- a/config/config.exs +++ b/config/config.exs @@ -4,6 +4,8 @@ config :plausible, ecto_repos: [Plausible.Repo, Plausible.IngestRepo] config :plausible, PlausibleWeb.Endpoint, + # Does not to have to be secret, as per: https://github.com/phoenixframework/phoenix/issues/2146 + live_view: [signing_salt: "f+bZg/crMtgjZJJY7X6OwIWc3XJR2C5Y"], pubsub_server: Plausible.PubSub, render_errors: [ view: PlausibleWeb.ErrorView, diff --git a/config/dev.exs b/config/dev.exs index 77acf097a..966ab93ab 100644 --- a/config/dev.exs +++ b/config/dev.exs @@ -25,8 +25,10 @@ config :plausible, PlausibleWeb.Endpoint, ~r{priv/static/.*(js|css|png|jpeg|jpg|gif|svg)$}, ~r{lib/plausible_web/views/.*(ex)$}, ~r{lib/plausible_web/templates/.*(eex)$}, + ~r{lib/plausible_web/templates/.*(heex)$}, ~r{lib/plausible_web/controllers/.*(ex)$}, - ~r{lib/plausible_web/plugs/.*(ex)$} + ~r{lib/plausible_web/plugs/.*(ex)$}, + ~r{lib/plausible_web/live/.*(ex)$} ] ] diff --git a/lib/plausible/funnels.ex b/lib/plausible/funnels.ex index ce290c6d9..fc4b67084 100644 --- a/lib/plausible/funnels.ex +++ b/lib/plausible/funnels.ex @@ -13,6 +13,11 @@ defmodule Plausible.Funnels do import Ecto.Query + @spec enabled_for?(any()) :: boolean() + def enabled_for?(actor) do + FunWithFlags.enabled?(:funnels, for: actor) + end + @spec create(Plausible.Site.t(), String.t(), [Plausible.Goal.t()]) :: {:ok, Funnel.t()} | {:error, Ecto.Changeset.t() | :invalid_funnel_size} diff --git a/lib/plausible/goals.ex b/lib/plausible/goals.ex index 3b4bbf2c7..5e1c3827d 100644 --- a/lib/plausible/goals.ex +++ b/lib/plausible/goals.ex @@ -91,6 +91,17 @@ defmodule Plausible.Goals do query end + query = + if opts[:preload_funnels?] do + from(g in query, + left_join: assoc(g, :funnels), + group_by: g.id, + preload: [:funnels] + ) + else + query + end + query |> Repo.all() |> Enum.map(&maybe_trim/1) @@ -149,10 +160,9 @@ defmodule Plausible.Goals do |> Multi.delete_all( :delete_goals, fn _ -> - from(g in Goal, + from g in Goal, where: g.id == ^id, where: g.site_id == ^site.id - ) end ) |> Repo.transaction() @@ -163,6 +173,17 @@ defmodule Plausible.Goals do end end + @spec count(Plausible.Site.t()) :: non_neg_integer() + def count(site) do + Repo.aggregate( + from( + g in Goal, + where: g.site_id == ^site.id + ), + :count + ) + end + defp maybe_trim(%Goal{} = goal) do # we make sure that even if we saved goals erroneously with trailing # space, it's removed during fetch diff --git a/lib/plausible/site.ex b/lib/plausible/site.ex index e8051d553..55d213808 100644 --- a/lib/plausible/site.ex +++ b/lib/plausible/site.ex @@ -18,9 +18,9 @@ defmodule Plausible.Site do field :stats_start_date, :date field :native_stats_start_at, :naive_datetime field :allowed_event_props, {:array, :string} - field :conversions_enabled, :boolean - field :props_enabled, :boolean - field :funnels_enabled, :boolean + field :conversions_enabled, :boolean, default: true + field :props_enabled, :boolean, default: true + field :funnels_enabled, :boolean, default: true field :ingest_rate_limit_scale_seconds, :integer, default: 60 # default is set via changeset/2 @@ -170,13 +170,20 @@ defmodule Plausible.Site do change(site, allowed_event_props: list) end - def disable_feature(site, "conversions"), do: change(site, conversions_enabled: false) - def disable_feature(site, "funnels"), do: change(site, funnels_enabled: false) - def disable_feature(site, "props"), do: change(site, props_enabled: false) + @togglable_features ~w[conversions_enabled funnels_enabled props_enabled]a + def feature_toggle_change(site, property, opts \\ []) + when property in @togglable_features do + override = Keyword.get(opts, :override) - def enable_feature(site, "conversions"), do: change(site, conversions_enabled: true) - def enable_feature(site, "funnels"), do: change(site, funnels_enabled: true) - def enable_feature(site, "props"), do: change(site, props_enabled: true) + attrs = + if is_boolean(override) do + %{property => override} + else + %{property => !Map.fetch!(site, property)} + end + + cast(site, attrs, @togglable_features) + end def remove_imported_data(site) do change(site, imported_data: nil) diff --git a/lib/plausible_web/components/generic.ex b/lib/plausible_web/components/generic.ex new file mode 100644 index 000000000..2ab608009 --- /dev/null +++ b/lib/plausible_web/components/generic.ex @@ -0,0 +1,40 @@ +defmodule PlausibleWeb.Components.Generic do + @moduledoc """ + Generic reusable components + """ + use Phoenix.Component + + attr :title, :string, default: "Notice" + slot :inner_block + + def notice(assigns) do + ~H""" +
+
+
+ +
+
+

<%= @title %>

+
+

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

+
+
+
+
+ """ + end +end diff --git a/lib/plausible_web/components/site/feature.ex b/lib/plausible_web/components/site/feature.ex new file mode 100644 index 000000000..2dc25ff7e --- /dev/null +++ b/lib/plausible_web/components/site/feature.ex @@ -0,0 +1,56 @@ +defmodule PlausibleWeb.Components.Site.Feature do + @moduledoc """ + Phoenix Component for rendering a user-facing feature toggle + capable of flipping booleans in `Plausible.Site` via the `toggle_feature` controller action. + """ + use PlausibleWeb, :view + + attr :site, Plausible.Site, required: true + attr :setting, :atom, required: true + attr :label, :string, required: true + attr :conn, Plug.Conn, required: true + slot :inner_block + + def toggle(assigns) do + ~H""" +
+
+ <%= if Map.fetch!(@site, @setting) do %> + <.button_active to={target(@site, @setting, @conn, false)} /> + <% else %> + <.button_inactive to={target(@site, @setting, @conn, true)} /> + <% end %> + + <%= @label %> + +
+
+ <%= render_slot(@inner_block) %> +
+
+ """ + end + + def target(site, setting, conn, set_to) when is_boolean(set_to) do + r = conn.request_path + Routes.site_path(conn, :update_feature_visibility, site.domain, setting, r: r, set: set_to) + end + + def button_active(assigns) do + ~H""" + <%= button(to: @to, 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 %> + """ + end + + def button_inactive(assigns) do + ~H""" + <%= button(to: @to, 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 +end diff --git a/lib/plausible_web/controllers/api/internal_controller.ex b/lib/plausible_web/controllers/api/internal_controller.ex index 751fcb6fc..b721bc9d0 100644 --- a/lib/plausible_web/controllers/api/internal_controller.ex +++ b/lib/plausible_web/controllers/api/internal_controller.ex @@ -36,8 +36,15 @@ defmodule PlausibleWeb.Api.InternalController do with %User{id: user_id} <- conn.assigns[:current_user], site <- Sites.get_by_domain(domain), true <- Sites.has_admin_access?(user_id, site) || Auth.is_super_admin?(user_id) do - Site.disable_feature(site, feature) - |> Repo.update() + property = + case feature do + "funnels" -> :funnels_enabled + "props" -> :props_enabled + "conversions" -> :conversions_enabled + end + + change = Plausible.Site.feature_toggle_change(site, property, override: false) + Repo.update!(change) json(conn, "ok") else diff --git a/lib/plausible_web/controllers/site_controller.ex b/lib/plausible_web/controllers/site_controller.ex index 2ee92f949..1d2ba80d4 100644 --- a/lib/plausible_web/controllers/site_controller.ex +++ b/lib/plausible_web/controllers/site_controller.ex @@ -171,32 +171,45 @@ defmodule PlausibleWeb.SiteController do end end - def set_feature_status(conn, %{"action" => action, "feature" => feature}) do + @feature_titles %{ + funnels_enabled: "Funnels", + conversions_enabled: "Goals", + props_enabled: "Properties" + } + def update_feature_visibility(conn, %{ + "setting" => setting, + "r" => "/" <> _ = redirect_path, + "set" => value + }) + when setting in ~w[conversions_enabled funnels_enabled props_enabled] and + value in ["true", "false"] do site = conn.assigns[:site] - report_title = - case feature do - "conversions" -> "Goals" - "funnels" -> "Funnels" - "props" -> "Properties" - end - - {change, flash_msg} = - case action do - "enable" -> - {Plausible.Site.enable_feature(site, feature), - "#{report_title} are now visible again on your dashboard"} + setting = String.to_existing_atom(setting) + change = Plausible.Site.feature_toggle_change(site, setting, override: value == "true") + result = Repo.update(change) - "disable" -> - {Plausible.Site.disable_feature(site, feature), - "#{report_title} are now hidden from your dashboard"} - end + case result do + {:ok, updated_site} -> + message = + if Map.fetch!(updated_site, setting) do + "#{@feature_titles[setting]} are now visible again on your dashboard" + else + "#{@feature_titles[setting]} are now hidden from your dashboard" + end - Repo.update(change) + conn + |> put_flash(:success, message) + |> redirect(to: redirect_path) - conn - |> put_flash(:success, flash_msg) - |> redirect(to: Routes.site_path(conn, :settings_goals, conn.assigns[:site].domain)) + {:error, _} -> + conn + |> put_flash( + :error, + "Something went wrong. Failed to toggle #{@feature_titles[setting]} on your dashboard." + ) + |> redirect(to: redirect_path) + end end def settings(conn, %{"website" => website}) do @@ -253,7 +266,7 @@ defmodule PlausibleWeb.SiteController do def settings_goals(conn, _params) do site = conn.assigns[:site] |> Repo.preload(:custom_domain) - goals = Goals.for_site(site) + goals = Goals.for_site(site, preload_funnels?: true) conn |> assign(:skip_plausible_tracking, true) @@ -264,6 +277,21 @@ defmodule PlausibleWeb.SiteController do ) end + def settings_funnels(conn, _params) do + if Plausible.Funnels.enabled_for?(conn.assigns[:current_user]) do + site = conn.assigns[:site] |> Repo.preload(:custom_domain) + + conn + |> assign(:skip_plausible_tracking, true) + |> render("settings_funnels.html", + site: site, + layout: {PlausibleWeb.LayoutView, "site_settings.html"} + ) + else + conn |> Plug.Conn.put_status(401) |> Plug.Conn.halt() + end + end + def settings_search_console(conn, _params) do site = conn.assigns[:site] @@ -877,11 +905,10 @@ defmodule PlausibleWeb.SiteController do cond do site.imported_data -> Oban.cancel_all_jobs( - from(j in Oban.Job, + from j in Oban.Job, where: j.queue == "google_analytics_imports" and fragment("(? ->> 'site_id')::int", j.args) == ^site.id - ) ) Plausible.Imported.forget(site) diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex index b32d8c8d3..0e9ec1d50 100644 --- a/lib/plausible_web/controllers/stats_controller.ex +++ b/lib/plausible_web/controllers/stats_controller.ex @@ -328,7 +328,7 @@ defmodule PlausibleWeb.StatsController do defp get_flags(user) do %{ - funnels: FunWithFlags.enabled?(:funnels, for: user), + funnels: Plausible.Funnels.enabled_for?(user), props: FunWithFlags.enabled?(:props, for: user) } end diff --git a/lib/plausible_web/endpoint.ex b/lib/plausible_web/endpoint.ex index 90172f0c3..8bfba7f05 100644 --- a/lib/plausible_web/endpoint.ex +++ b/lib/plausible_web/endpoint.ex @@ -2,6 +2,15 @@ defmodule PlausibleWeb.Endpoint do use Sentry.PlugCapture use Phoenix.Endpoint, otp_app: :plausible + @session_options [ + store: :cookie, + key: "_plausible_key", + signing_salt: "3IL0ob4k", + # 5 years, this is super long but the SlidingSessionTimeout will log people out if they don't return for 2 weeks + max_age: 60 * 60 * 24 * 365 * 5, + extra: "SameSite=Lax" + ] + # Serve at "/" the static files from "priv/static" directory. # # You should set gzip to true if you are running phx.digest @@ -43,13 +52,9 @@ defmodule PlausibleWeb.Endpoint do plug Plug.MethodOverride plug Plug.Head - plug Plug.Session, - store: :cookie, - key: "_plausible_key", - signing_salt: "3IL0ob4k", - # 5 years, this is super long but the SlidingSessionTimeout will log people out if they don't return for 2 weeks - max_age: 60 * 60 * 24 * 365 * 5, - extra: "SameSite=Lax" + plug Plug.Session, @session_options + + socket "/live", Phoenix.LiveView.Socket, websocket: [connect_info: [session: @session_options]] plug CORSPlug plug PlausibleWeb.Router diff --git a/lib/plausible_web/live/flash.ex b/lib/plausible_web/live/flash.ex new file mode 100644 index 000000000..ee963a667 --- /dev/null +++ b/lib/plausible_web/live/flash.ex @@ -0,0 +1,137 @@ +defmodule PlausibleWeb.Live.Flash do + @moduledoc """ + Flash component for LiveViews - works also when embedded within dead views + """ + use Phoenix.LiveComponent + alias Phoenix.LiveView.JS + alias Phoenix.Flash + + def render(assigns) do + ~H""" +
+
+ <.flash> + <:icon> + <.icon_success :if={Flash.get(@flash, :success)} /> + <.icon_error :if={Flash.get(@flash, :error)} /> + + <:title :if={Flash.get(@flash, :success)}> + <%= Flash.get(@flash, :success_title) || "Success!" %> + + <:message> + <%= Flash.get(@flash, :success) %> + + +
+ +
+ """ + end + + slot(:icon, required: true) + slot(:title, require: true) + slot(:message, required: true) + attr(:on_close, :any, default: "lv:clear-flash") + + def flash(assigns) do + ~H""" +
+
+
+
+
+ <%= render_slot(@icon) %> +
+

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

+

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

+
+
+ <.clear_flash_button on_close={@on_close} /> +
+
+
+
+
+
+ """ + end + + def icon_success(assigns) do + ~H""" +
+ + + +
+ """ + end + + def icon_error(assigns) do + ~H""" + + + + + """ + end + + def clear_flash_button(assigns) do + ~H""" + + """ + end +end diff --git a/lib/plausible_web/live/funnel_settings.ex b/lib/plausible_web/live/funnel_settings.ex new file mode 100644 index 000000000..5aef5bcb4 --- /dev/null +++ b/lib/plausible_web/live/funnel_settings.ex @@ -0,0 +1,99 @@ +defmodule PlausibleWeb.Live.FunnelSettings do + @moduledoc """ + LiveView allowing listing, creating and deleting funnels. + """ + use Phoenix.LiveView + use Phoenix.HTML + + use Plausible.Funnel + + alias Plausible.{Sites, Goals, Funnels} + + def mount( + _params, + %{"site_id" => _site_id, "domain" => domain, "current_user_id" => user_id}, + socket + ) do + true = Plausible.Funnels.enabled_for?("user:#{user_id}") + site = Sites.get_for_user!(user_id, domain, [:owner, :admin]) + + funnels = Funnels.list(site) + goal_count = Goals.count(site) + + {:ok, + assign(socket, + site_id: site.id, + domain: site.domain, + funnels: funnels, + goal_count: goal_count, + add_funnel?: false, + current_user_id: user_id + )} + 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_funnel? do %> + <%= live_render( + @socket, + PlausibleWeb.Live.FunnelSettings.Form, + id: "funnels-form", + session: %{ + "current_user_id" => @current_user_id, + "domain" => @domain + } + ) %> + <% else %> +
= Funnel.min_steps()}> + <.live_component + module={PlausibleWeb.Live.FunnelSettings.List} + id="funnels-list" + funnels={@funnels} + /> + +
+ +
+ + You need to define at least two goals to create a funnel. Go ahead and <%= link( + "add goals", + to: PlausibleWeb.Router.Helpers.site_path(@socket, :new_goal, @domain), + class: "text-indigo-500 w-full text-center" + ) %> to proceed. + +
+ <% end %> +
+ """ + end + + def handle_event("add-funnel", _value, socket) do + {:noreply, assign(socket, add_funnel?: true)} + end + + def handle_event("cancel-add-funnel", _value, socket) do + {:noreply, assign(socket, add_funnel?: false)} + end + + def handle_event("delete-funnel", %{"funnel-id" => id}, socket) do + id = String.to_integer(id) + :ok = Funnels.delete(socket.assigns.site, id) + socket = put_flash(socket, :success, "Funnel deleted successfully") + Process.send_after(self(), :clear_flash, 5000) + {:noreply, assign(socket, funnels: Funnels.list(socket.assigns.site))} + end + + def handle_info({:funnel_saved, funnel}, socket) do + socket = put_flash(socket, :success, "Funnel saved successfully") + Process.send_after(self(), :clear_flash, 5000) + {:noreply, assign(socket, add_funnel?: false, funnels: [funnel | socket.assigns.funnels])} + end + + def handle_info(:clear_flash, socket) do + {:noreply, clear_flash(socket)} + end +end diff --git a/lib/plausible_web/live/funnel_settings/combo_box.ex b/lib/plausible_web/live/funnel_settings/combo_box.ex new file mode 100644 index 000000000..8d2098439 --- /dev/null +++ b/lib/plausible_web/live/funnel_settings/combo_box.ex @@ -0,0 +1,257 @@ +defmodule PlausibleWeb.Live.FunnelSettings.ComboBox do + @moduledoc """ + Phoenix LiveComponent for a combobox UI element with search and selection + functionality. + + The component allows users to select an option from a list of options, + which can be searched by typing in the input field. + + The component renders an input field with a dropdown anchor and a + hidden input field for submitting the selected value. + + The number of options displayed in the dropdown is limited to 15 + by default but can be customized. When a user types into the input + field, the component searches the available options and provides + suggestions based on the input. + """ + use Phoenix.LiveComponent + alias Phoenix.LiveView.JS + + @max_options_displayed 15 + + def update(assigns, socket) do + socket = + socket + |> assign(assigns) + |> assign_new(:suggestions, fn -> + Enum.take(assigns.options, @max_options_displayed) + end) + + {:ok, socket} + end + + attr(:placeholder, :string, default: "Select option or search by typing") + attr(:id, :any, required: true) + attr(:options, :list, required: true) + attr(:submit_name, :string, required: true) + attr(:display_value, :string, default: "") + attr(:submit_value, :string, default: "") + + def render(assigns) do + ~H""" +
+
+
+ + + <.dropdown_anchor id={@id} /> + + +
+
+ + <.dropdown ref={@id} options={@options} suggestions={@suggestions} target={@myself} /> +
+ """ + end + + attr(:id, :any, required: true) + + def dropdown_anchor(assigns) do + ~H""" +
+ +
+ """ + end + + attr(:ref, :string, required: true) + attr(:options, :list, default: []) + attr(:suggestions, :list, default: []) + attr(:target, :any) + + def dropdown(assigns) do + ~H""" + + """ + end + + attr(:display_value, :string, required: true) + attr(:submit_value, :integer, required: true) + attr(:ref, :string, required: true) + attr(:target, :any) + attr(:idx, :integer, required: true) + + def option(assigns) do + assigns = assign(assigns, :max_options_displayed, @max_options_displayed) + + ~H""" +
  • + + + <%= @display_value %> + + +
  • +
  • + Max results reached. Refine your search by typing in goal name. +
  • + """ + end + + def select_option(js \\ %JS{}, _id, submit_value, display_value) do + js + |> JS.push("select-option", + value: %{"submit-value" => submit_value, "display-value" => display_value} + ) + end + + def handle_event( + "select-option", + %{"submit-value" => submit_value, "display-value" => display_value}, + socket + ) do + socket = do_select(socket, submit_value, display_value) + {:noreply, socket} + end + + def handle_event("search", %{"_target" => [target]} = params, socket) do + input = params[target] + input_len = input |> String.trim() |> String.length() + + if input_len > 0 do + suggestions = suggest(input, socket.assigns.options) + {:noreply, assign(socket, %{suggestions: suggestions})} + else + {:noreply, socket} + end + end + + def suggest(input, options) do + input_len = String.length(input) + + options + |> Enum.reject(fn {_, value} -> + input_len > String.length(to_string(value)) + end) + |> Enum.sort_by( + fn {_, value} -> + if to_string(value) == input do + 3 + else + value = to_string(value) + input = String.downcase(input) + value = String.downcase(value) + weight = if String.contains?(value, input), do: 1, else: 0 + weight + String.jaro_distance(value, input) + end + end, + :desc + ) + |> Enum.take(@max_options_displayed) + end + + defp do_select(socket, submit_value, display_value) do + id = socket.assigns.id + + socket = + socket + |> push_event("update-value", %{id: id, value: display_value, fire: false}) + |> push_event("update-value", %{id: "submit-#{id}", value: submit_value, fire: true}) + |> assign(:display_value, display_value) + |> assign(:submit_value, submit_value) + + send( + self(), + {:selection_made, + %{ + by: id, + submit_value: submit_value + }} + ) + + socket + end +end diff --git a/lib/plausible_web/live/funnel_settings/form.ex b/lib/plausible_web/live/funnel_settings/form.ex new file mode 100644 index 000000000..615319b5c --- /dev/null +++ b/lib/plausible_web/live/funnel_settings/form.ex @@ -0,0 +1,271 @@ +defmodule PlausibleWeb.Live.FunnelSettings.Form do + @moduledoc """ + Phoenix LiveComponent that renders a form used for setting up funnels. + Makes use of dynamically placed `PlausibleWeb.Live.FunnelSettings.ComboBox` components + to allow building searchable funnel definitions out of list of goals available. + """ + + use Phoenix.LiveView + use Phoenix.HTML + use Plausible.Funnel + + alias Plausible.{Sites, Goals} + + def mount(_params, %{"current_user_id" => user_id, "domain" => domain}, socket) do + site = Sites.get_for_user!(user_id, domain, [:owner, :admin]) + + # We'll have the options trimmed to only the data we care about, to keep + # it minimal at the socket assigns, yet, we want to retain specific %Goal{} + # fields, so that `String.Chars` protocol and `Funnels.ephemeral_definition/3` + # are applicable downstream. + goals = + site + |> Goals.for_site() + |> Enum.map(fn goal -> + {goal.id, struct!(Plausible.Goal, Map.take(goal, [:id, :event_name, :page_path]))} + end) + + {:ok, + assign(socket, + step_ids: Enum.to_list(1..Funnel.min_steps()), + form: to_form(Plausible.Funnels.create_changeset(site, "", [])), + goals: goals, + site: site, + already_selected: Map.new() + )} + end + + def render(assigns) do + ~H""" +
    +
    + <.form + :let={f} + for={@form} + phx-change="validate" + phx-submit="save" + phx-target="#funnel-form" + onkeydown="return event.key != 'Enter';" + > + <%= label(f, "Funnel name", + class: "block text-sm font-medium text-gray-700 dark:text-gray-300 mb-2" + ) %> + <.input field={f[:name]} /> + +
    + <%= label(f, "Funnel Steps", + class: "mt-6 block text-sm font-medium text-gray-700 dark:text-gray-300 mb-2" + ) %> + +
    +
    + <.live_component + submit_name="funnel[steps][][goal_id]" + module={PlausibleWeb.Live.FunnelSettings.ComboBox} + id={"step-#{step_idx}"} + options={reject_alrady_selected("step-#{step_idx}", @goals, @already_selected)} + /> +
    + + <.remove_step_button :if={length(@step_ids) > Funnel.min_steps()} step_idx={step_idx} /> +
    + + <.add_step_button :if={ + length(@step_ids) < Funnel.max_steps() and + map_size(@already_selected) < length(@goals) + } /> + +
    + <%= if has_steps_errors?(f) do %> + <.submit_button_inactive /> + <% else %> + <.submit_button /> + <% end %> + <.cancel_button /> +
    +
    + +
    +
    + """ + end + + attr(:field, Phoenix.HTML.FormField) + + def input(assigns) do + ~H""" +
    + + + <.error :for={{msg, _} <- @field.errors}>Funnel name <%= msg %> +
    + """ + end + + def error(assigns) do + ~H""" +
    + <%= render_slot(@inner_block) %> +
    + """ + end + + attr(:step_idx, :integer, required: true) + + def remove_step_button(assigns) do + ~H""" +
    + + + + + + + +
    + """ + end + + def add_step_button(assigns) do + ~H""" + + + Add another step + + """ + end + + def submit_button(assigns) do + ~H""" + + """ + end + + def submit_button_inactive(assigns) do + ~H""" + + """ + end + + def cancel_button(assigns) do + ~H""" + + """ + end + + def handle_event("add-step", _value, socket) do + step_ids = socket.assigns.step_ids + + if length(step_ids) < Funnel.max_steps() do + first_free_idx = find_sequence_break(step_ids) + new_ids = step_ids ++ [first_free_idx] + {:noreply, assign(socket, step_ids: new_ids)} + else + {:noreply, socket} + end + end + + def handle_event("remove-step", %{"step-idx" => idx}, socket) do + idx = String.to_integer(idx) + step_ids = List.delete(socket.assigns.step_ids, idx) + already_selected = socket.assigns.already_selected + + step_input_id = "step-#{idx}" + + new_already_selected = Map.delete(already_selected, step_input_id) + + {:noreply, assign(socket, step_ids: step_ids, already_selected: new_already_selected)} + end + + def handle_event("validate", %{"funnel" => params}, socket) do + changeset = + socket.assigns.site + |> Plausible.Funnels.create_changeset( + params["name"], + params["steps"] || [] + ) + |> Map.put(:action, :validate) + + {:noreply, assign(socket, form: to_form(changeset))} + end + + def handle_event("save", %{"funnel" => params}, %{assigns: %{site: site}} = socket) do + case Plausible.Funnels.create(site, params["name"], params["steps"]) do + {:ok, funnel} -> + send( + socket.parent_pid, + {:funnel_saved, Map.put(funnel, :steps_count, length(params["steps"]))} + ) + + {:noreply, socket} + + {:error, changeset} -> + {:noreply, + assign(socket, + form: to_form(Map.put(changeset, :action, :validate)) + )} + end + end + + def handle_info({:selection_made, %{submit_value: goal_id, by: combo_box}}, socket) do + already_selected = Map.put(socket.assigns.already_selected, combo_box, goal_id) + {:noreply, assign(socket, already_selected: already_selected)} + end + + defp reject_alrady_selected(combo_box, goals, already_selected) do + result = Enum.reject(goals, fn {goal_id, _} -> goal_id in Map.values(already_selected) end) + send_update(PlausibleWeb.Live.FunnelSettings.ComboBox, id: combo_box, suggestions: result) + result + end + + defp find_sequence_break(input) do + input + |> Enum.sort() + |> Enum.with_index(1) + |> Enum.reduce_while(nil, fn {x, order}, _ -> + if x != order do + {:halt, order} + else + {:cont, order + 1} + end + end) + end + + defp has_steps_errors?(f) do + not f.source.valid? + end +end diff --git a/lib/plausible_web/live/funnel_settings/list.ex b/lib/plausible_web/live/funnel_settings/list.ex new file mode 100644 index 000000000..e25713ffd --- /dev/null +++ b/lib/plausible_web/live/funnel_settings/list.ex @@ -0,0 +1,59 @@ +defmodule PlausibleWeb.Live.FunnelSettings.List do + @moduledoc """ + Phoenix LiveComponent module that renders a list of funnels with their names + and the number of steps they have. + + Each funnel is displayed with a delete button, which triggers a confirmation + message before deleting the funnel from the UI. If there are no funnels + configured for the site, a message is displayed indicating so. + """ + use Phoenix.LiveComponent + use Phoenix.HTML + + def render(assigns) do + ~H""" +
    + <%= if Enum.count(@funnels) > 0 do %> +
    + <%= for funnel <- @funnels do %> +
    + + <%= funnel.name %> +
    + + <%= funnel.steps_count %>-step funnel + +
    + +
    + <% end %> +
    + <% else %> +
    No funnels configured for this site yet
    + <% end %> +
    + """ + end +end diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.ex index 7ef5d2352..62882c15b 100644 --- a/lib/plausible_web/router.ex +++ b/lib/plausible_web/router.ex @@ -1,11 +1,12 @@ defmodule PlausibleWeb.Router do use PlausibleWeb, :router + import Phoenix.LiveView.Router @two_weeks_in_seconds 60 * 60 * 24 * 14 pipeline :browser do plug :accepts, ["html"] plug :fetch_session - plug :fetch_flash + plug :fetch_live_flash plug :put_secure_browser_headers plug PlausibleWeb.FirstLaunchPlug, redirect_to: "/register" plug PlausibleWeb.SessionTimeoutPlug, timeout_after_seconds: @two_weeks_in_seconds @@ -148,6 +149,11 @@ defmodule PlausibleWeb.Router do post "/share/:slug/authenticate", StatsController, :authenticate_shared_link end + scope "/:website/settings/funnels/", PlausibleWeb do + pipe_through [:browser, :csrf] + get "/", SiteController, :settings_funnels + end + scope "/", PlausibleWeb do pipe_through [:browser, :csrf] @@ -246,6 +252,7 @@ defmodule PlausibleWeb.Router do get "/:website/settings/people", SiteController, :settings_people get "/:website/settings/visibility", SiteController, :settings_visibility get "/:website/settings/goals", SiteController, :settings_goals + get "/:website/settings/search-console", SiteController, :settings_search_console get "/:website/settings/email-reports", SiteController, :settings_email_reports get "/:website/settings/custom-domain", SiteController, :settings_custom_domain @@ -253,7 +260,11 @@ defmodule PlausibleWeb.Router do get "/:website/goals/new", SiteController, :new_goal post "/:website/goals", SiteController, :create_goal delete "/:website/goals/:id", SiteController, :delete_goal - put "/:website/settings/features/:action/:feature", SiteController, :set_feature_status + + put "/:website/settings/features/visibility/:setting", + SiteController, + :update_feature_visibility + put "/:website/settings", SiteController, :update_settings put "/:website/settings/google", SiteController, :update_google_auth delete "/:website/settings/google-search", SiteController, :delete_google_auth diff --git a/lib/plausible_web/templates/layout/app.html.eex b/lib/plausible_web/templates/layout/app.html.eex index af8795294..ff0873031 100644 --- a/lib/plausible_web/templates/layout/app.html.eex +++ b/lib/plausible_web/templates/layout/app.html.eex @@ -5,6 +5,7 @@ + /> "> <%= assigns[:title] || "Plausible ยท Simple, privacy-friendly alternative to Google Analytics" %> diff --git a/lib/plausible_web/templates/site/settings_funnels.html.heex b/lib/plausible_web/templates/site/settings_funnels.html.heex new file mode 100644 index 000000000..33c1058be --- /dev/null +++ b/lib/plausible_web/templates/site/settings_funnels.html.heex @@ -0,0 +1,35 @@ +
    +
    +

    Funnels

    +

    + Compose goals into funnels +

    + <%= link(to: "https://plausible.io/docs/funnel-analysis", target: "_blank", rel: "noreferrer") do %> + + + + + <% end %> +
    + + + <%= live_render(@conn, PlausibleWeb.Live.FunnelSettings, + session: %{"site_id" => @site.id, "domain" => @site.domain}, + router: PlausibleWeb.Router + ) %> + +
    diff --git a/lib/plausible_web/templates/site/settings_goals.html.eex b/lib/plausible_web/templates/site/settings_goals.html.eex deleted file mode 100644 index 17630e120..000000000 --- a/lib/plausible_web/templates/site/settings_goals.html.eex +++ /dev/null @@ -1,42 +0,0 @@ -
    -
    -

    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 @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])