Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Strict order funnels (#6237)
Adam Rutkowskiea3d23d87981
diff --git a/extra/lib/plausible/funnel.ex b/extra/lib/plausible/funnel.exindex abd3724f87..f30d295276 100644--- a/extra/lib/plausible/funnel.ex+++ b/extra/lib/plausible/funnel.ex@@ -41,6 +41,7 @@ defmodule Plausible.Funnel do@type t() :: %__MODULE__{}schema "funnels" dofield :name, :string+ field :strict_order, :boolean, default: falsebelongs_to :site, Plausible.Sitehas_many :steps, Step,@@ -55,7 +56,7 @@ defmodule Plausible.Funnel dodef changeset(funnel \\ %__MODULE__{}, attrs \\ %{}) dofunnel- |> cast(attrs, [:name])+ |> cast(attrs, [:name, :strict_order])|> validate_required([:name])|> put_steps(attrs[:steps] || attrs["steps"])|> validate_length(:steps, min: @min_steps, max: @max_steps)diff --git a/extra/lib/plausible/funnels.ex b/extra/lib/plausible/funnels.exindex 24ac019cbf..feebbf65e1 100644--- a/extra/lib/plausible/funnels.ex+++ b/extra/lib/plausible/funnels.ex@@ -13,10 +13,12 @@ defmodule Plausible.Funnels doimport Ecto.Query- @spec create(Plausible.Site.t(), String.t(), [map()]) ::+ @spec create(Plausible.Site.t(), String.t(), [map()], Keyword.t()) ::{:ok, Funnel.t()}| {:error, Ecto.Changeset.t() | :invalid_funnel_size | :upgrade_required}- def create(site, name, steps)+ def create(site, name, steps, opts \\ [])++ def create(site, name, steps, opts)when is_list(steps) and length(steps) in Funnel.min_steps()..Funnel.max_steps() dosite = Plausible.Repo.preload(site, :team)@@ -26,19 +28,19 @@ defmodule Plausible.Funnels do:ok ->site- |> create_changeset(name, steps)+ |> create_changeset(name, steps, opts)|> Repo.insert()endend- def create(_site, _name, _goals) do+ def create(_site, _name, _goals, _opts) do{:error, :invalid_funnel_size}end- @spec update(Funnel.t(), String.t(), [map()]) ::+ @spec update(Funnel.t(), String.t(), [map()], Keyword.t()) ::{:ok, Funnel.t()}| {:error, Ecto.Changeset.t() | :invalid_funnel_size | :upgrade_required}- def update(funnel, name, steps) do+ def update(funnel, name, steps, opts \\ []) dosite = Plausible.Repo.preload(funnel, site: :team).sitecase Plausible.Billing.Feature.Funnels.check_availability(site.team) do@@ -47,27 +49,37 @@ defmodule Plausible.Funnels do:ok ->funnel- |> Funnel.changeset(%{name: name, steps: steps})+ |> edit_changeset(name, steps,+ strict_order?: Keyword.get(opts, :strict_order?, !!funnel.strict_order)+ )|> Repo.update()endend- @spec create_changeset(Plausible.Site.t(), String.t(), [map()]) ::+ @spec create_changeset(Plausible.Site.t(), String.t(), [map()], Keyword.t()) ::Ecto.Changeset.t()- def create_changeset(site, name, steps) do- Funnel.changeset(%Funnel{site_id: site.id}, %{name: name, steps: steps})+ def create_changeset(site, name, steps, opts \\ []) do+ Funnel.changeset(%Funnel{site_id: site.id}, %{+ name: name,+ steps: steps,+ strict_order: Keyword.get(opts, :strict_order?, false)+ })end- @spec edit_changeset(Plausible.Funnel.t(), String.t(), [map()]) ::+ @spec edit_changeset(Plausible.Funnel.t(), String.t(), [map()], Keyword.t()) ::Ecto.Changeset.t()- def edit_changeset(funnel, name, steps) do- Funnel.changeset(funnel, %{name: name, steps: steps})+ def edit_changeset(funnel, name, steps, opts) do+ Funnel.changeset(funnel, %{+ name: name,+ steps: steps,+ strict_order: Keyword.get(opts, :strict_order?, false)+ })end- @spec ephemeral_definition(Plausible.Site.t(), String.t(), [map()]) :: Funnel.t()- def ephemeral_definition(site, name, steps) do+ @spec ephemeral_definition(Plausible.Site.t(), String.t(), [map()], Keyword.t()) :: Funnel.t()+ def ephemeral_definition(site, name, steps, opts \\ []) dosite- |> create_changeset(name, steps)+ |> create_changeset(name, steps, opts)|> Ecto.Changeset.apply_changes()enddiff --git a/extra/lib/plausible/stats/funnel.ex b/extra/lib/plausible/stats/funnel.exindex 5614c640b6..7629dd595e 100644--- a/extra/lib/plausible/stats/funnel.ex+++ b/extra/lib/plausible/stats/funnel.ex@@ -93,10 +93,21 @@ defmodule Plausible.Stats.Funnel doend)dynamic_window_funnel =- dynamic(- [q],- fragment("windowFunnel(?)(timestamp, ?)", @funnel_window_duration, ^window_funnel_steps)- )+ if funnel_definition.strict_order do+ dynamic(+ [q],+ fragment(+ "windowFunnel(?, 'strict_order')(timestamp, ?)",+ @funnel_window_duration,+ ^window_funnel_steps+ )+ )+ else+ dynamic(+ [q],+ fragment("windowFunnel(?)(timestamp, ?)", @funnel_window_duration, ^window_funnel_steps)+ )+ endfrom(q in db_query,select_merge:diff --git a/extra/lib/plausible_web/live/funnel_settings/form.ex b/extra/lib/plausible_web/live/funnel_settings/form.exindex e273bd1400..6a46134a52 100644--- a/extra/lib/plausible_web/live/funnel_settings/form.ex+++ b/extra/lib/plausible_web/live/funnel_settings/form.ex@@ -80,6 +80,20 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form dolabel="Funnel name"/>+ <div class="mt-6 flex items-center justify-between gap-4">+ <span class="text-sm font-medium text-gray-900 dark:text-gray-100">+ Allow other steps between funnel steps+ </span>+ <div class="flex items-center gap-3">+ <.toggle_switch+ id="toggle-strict-order"+ id_suffix="switch"+ checked={!@strict_order?}+ phx-click="toggle-strict-order"+ />+ </div>+ </div>+<div id="steps-builder" class="mt-6"><.label>Funnel steps@@ -232,7 +246,16 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form doassign(socket, step_ids: step_ids, selections_made: selections_made, funnel_modified?: true)}end+ def handle_event("toggle-strict-order", _params, socket) do+ strict_order? = !socket.assigns.strict_order?+ send(self(), :evaluate_funnel)++ {:noreply, assign(socket, strict_order?: strict_order?)}+ end+def handle_event("validate", %{"funnel" => params}, socket) do+ strict_order? = socket.assigns.strict_order?+steps_from_assigns =socket.assigns.step_ids|> Enum.reduce([], fn step_id, acc ->@@ -245,7 +268,8 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form dosocket.assigns.site|> Funnels.create_changeset(params["name"],- steps_from_assigns+ steps_from_assigns,+ strict_order?: strict_order?)|> Map.put(:action, :validate)@@ -255,17 +279,17 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form dodef handle_event("save",%{"funnel" => params},- %{assigns: %{site: site, funnel: funnel}} = socket+ %{assigns: %{site: site, funnel: funnel, strict_order?: strict_order?}} = socket) dosteps = Enum.map(params["steps"], fn {_idx, payload} -> payload end)save_fn =case funnel do%Plausible.Funnel{} ->- fn -> Funnels.update(funnel, params["name"], steps) end+ fn -> Funnels.update(funnel, params["name"], steps, strict_order?: strict_order?) endnil ->- fn -> Funnels.create(site, params["name"], steps) end+ fn -> Funnels.create(site, params["name"], steps, strict_order?: strict_order?) endendcase save_fn.() do@@ -314,11 +338,13 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form do%{assigns: %{site: site,- selections_made: selections_made+ selections_made: selections_made,+ strict_order?: strict_order?}} = socket) do- with {:ok, {definition, query}} <- build_ephemeral_funnel(site, selections_made),+ with {:ok, {definition, query}} <-+ build_ephemeral_funnel(site, selections_made, strict_order?: strict_order?),{:ok, funnel} <- Plausible.Stats.funnel(site, query, definition) doassign(socket, evaluation_result: funnel)else@@ -327,7 +353,7 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form doendend- defp build_ephemeral_funnel(site, selections_made) do+ defp build_ephemeral_funnel(site, selections_made, opts) dosteps =selections_made|> Enum.sort_by(&elem(&1, 0))@@ -346,7 +372,8 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form doFunnels.ephemeral_definition(site,"Test funnel",- steps+ steps,+ opts)query =@@ -417,7 +444,8 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form dofunnel|> Funnels.edit_changeset(funnel.name,- Enum.map(funnel.steps, &%{goal_id: &1.goal.id})+ Enum.map(funnel.steps, &%{goal_id: &1.goal.id}),+ strict_order?: funnel.strict_order)|> to_form()@@ -431,6 +459,7 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form dosocket,form: form,funnel: funnel,+ strict_order?: funnel.strict_order,funnel_modified?: false,selections_made: selections_made,step_ids: Enum.to_list(1..Enum.count(funnel.steps))@@ -446,6 +475,7 @@ defmodule PlausibleWeb.Live.FunnelSettings.Form dosocket,form: form,funnel: nil,+ strict_order?: false,funnel_modified?: false,selections_made: Map.new(),step_ids: Enum.to_list(1..Funnel.min_steps())diff --git a/test/plausible/funnels_test.exs b/test/plausible/funnels_test.exsindex 53e3e2a296..48581ba86e 100644--- a/test/plausible/funnels_test.exs+++ b/test/plausible/funnels_test.exs@@ -43,6 +43,7 @@ defmodule Plausible.FunnelsTest doassert funnel.inserted_atassert funnel.name == "From blog to signup and purchase"+ assert funnel.strict_order == falseassert [fg1, fg2, fg3] = funnel.stepsassert fg1.goal_id == g1["goal_id"]@@ -76,6 +77,36 @@ defmodule Plausible.FunnelsTest doassert funnel1.id == funnel2.idend+ test "update funnel strict_order", %{site: site, steps: [g1, g2, g3 | _]} do+ {:ok, funnel} =+ Funnels.create(+ site,+ "Sample funnel",+ [g1, g2]+ )++ assert funnel.strict_order == false++ {:ok, strict_funnel} =+ Funnels.update(+ funnel,+ "Sample funnel",+ [g1, g2, g3],+ strict_order?: true+ )++ assert strict_funnel.strict_order == true++ {:ok, preserved_funnel} =+ Funnels.update(+ strict_funnel,+ "Sample funnel",+ [g1, g2]+ )++ assert preserved_funnel.strict_order == true+ end+test "retrieve a funnel by id and site, get steps in order", %{site: site,steps: [g1, g2, g3 | _]@@ -299,6 +330,57 @@ defmodule Plausible.FunnelsTest do}} = funnel_dataend+ test "strict-order funnels stop at intervention events", %{+ site: site,+ steps: [g1, g2, g3 | _]+ } do+ {:ok, non_strict_funnel} =+ Funnels.create(+ site,+ "From blog to signup and purchase",+ [g1, g2, g3]+ )++ {:ok, strict_funnel} =+ Funnels.create(+ site,+ "Strict from blog to signup and purchase",+ [g1, g2, g3],+ strict_order?: true+ )++ populate_stats(site, [+ build(:pageview,+ pathname: "/go/to/blog/foo",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:00:00]+ ),+ build(:pageview,+ pathname: "/some/other/page",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:00:01]+ ),+ build(:event,+ name: "Signup",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:00:02]+ ),+ build(:pageview,+ pathname: "/checkout",+ user_id: 123,+ timestamp: ~N[2021-01-01 00:00:03]+ )+ ])++ query = QueryBuilder.build!(site, input_date_range: :all)++ {:ok, non_strict_funnel_data} = Stats.funnel(site, query, non_strict_funnel.id)+ {:ok, strict_funnel_data} = Stats.funnel(site, query, strict_funnel.id)++ assert Enum.at(non_strict_funnel_data.steps, 2).visitors == 1+ assert Enum.at(strict_funnel_data.steps, 2).visitors == 0+ end+test "funnels can be evaluated even where there are no visits yet", %{site: site,steps: [g1, g2, g3 | _]diff --git a/test/plausible_web/live/funnel_settings_test.exs b/test/plausible_web/live/funnel_settings_test.exsindex 2fb874b2a4..5aec16db98 100644--- a/test/plausible_web/live/funnel_settings_test.exs+++ b/test/plausible_web/live/funnel_settings_test.exs@@ -326,7 +326,52 @@ defmodule PlausibleWeb.Live.FunnelSettingsTest do|> element(~s/form/)|> render_submit()- assert %Plausible.Funnel{steps: [_, _]} = Plausible.Funnels.get(site, "My test funnel")+ assert %Plausible.Funnel{steps: [_, _], strict_order: false} =+ Plausible.Funnels.get(site, "My test funnel")+ end++ test "save button saves strict-order setting", %{+ conn: conn,+ site: site+ } do+ {:ok, [g1, g2]} = setup_goals(site)++ {:ok, %Plausible.Funnel{strict_order: false} = funnel} =+ Plausible.Funnels.create(+ site,+ "Strict funnel",+ [%{"goal_id" => g1.id}, %{"goal_id" => g2.id}],+ strict_order?: false+ )++ lv = get_liveview(conn, site)++ lv+ |> element(~s/button[phx-click="edit-funnel"][phx-value-funnel-id="#{funnel.id}"]/)+ |> render_click()++ assert lv = find_live_child(lv, "funnels-form")++ assert element_exists?(+ render(lv),+ ~s/button#toggle-strict-order-switch[aria-checked="true"]/+ )++ lv+ |> element(~s/button#toggle-strict-order-switch[phx-click="toggle-strict-order"]/)+ |> render_click()++ assert element_exists?(+ render(lv),+ ~s/button#toggle-strict-order-switch[aria-checked="false"]/+ )++ lv+ |> element(~s/form/)+ |> render_submit()++ assert %Plausible.Funnel{strict_order: true} =+ Plausible.Funnels.get(site, "Strict funnel")endtest "editing a funnel pre-renders it", %{@@ -348,6 +393,54 @@ defmodule PlausibleWeb.Live.FunnelSettingsTest doassert lv |> element("#step-2") |> render() |> text_of_attr("value") == "Signup"end+ test "funnel is re-evaluated when strict-order is changed", %{+ conn: conn,+ site: site+ } do+ {:ok, [g1, g2]} = setup_goals(site)++ {:ok, funnel} =+ Plausible.Funnels.create(+ site,+ "Strict-order switch",+ [%{"goal_id" => g1.id}, %{"goal_id" => g2.id}]+ )++ ts = NaiveDateTime.utc_now() |> NaiveDateTime.truncate(:second)++ populate_stats(site, [+ build(:pageview, pathname: "/go/to/blog/foo", user_id: 123, timestamp: ts),+ build(:pageview,+ pathname: "/intervention",+ user_id: 123,+ timestamp: NaiveDateTime.add(ts, 1, :second)+ ),+ build(:event,+ name: "Signup",+ user_id: 123,+ timestamp: NaiveDateTime.add(ts, 2, :second)+ )+ ])++ lv = get_liveview(conn, site)++ lv+ |> element(~s/button[phx-click="edit-funnel"][phx-value-funnel-id="#{funnel.id}"]/)+ |> render_click()++ assert lv = find_live_child(lv, "funnels-form")++ assert text_of_element(render(lv), ~s/#step-eval-1/) =~ "Dropoff: 0%"+ assert text_of_element(render(lv), ~s/#funnel-eval/) =~ "Last month conversion rate: 100%"++ lv+ |> element(~s/button#toggle-strict-order-switch[phx-click="toggle-strict-order"]/)+ |> render_click()++ assert text_of_element(render(lv), ~s/#step-eval-1/) =~ "Dropoff: 100%"+ assert text_of_element(render(lv), ~s/#funnel-eval/) =~ "Last month conversion rate: 0%"+ end+test "clicking save after editing the funnel, updates it", %{conn: conn,site: site@@ -387,6 +480,40 @@ defmodule PlausibleWeb.Live.FunnelSettingsTest doPlausible.Funnels.get(site, "Updated funnel")end+ test "clicking save after editing the funnel, updates strict-order setting", %{+ conn: conn,+ site: site+ } do+ {:ok, [g1, g2]} = setup_goals(site)++ {:ok, funnel} =+ Plausible.Funnels.create(+ site,+ "Editable strict funnel",+ [%{"goal_id" => g1.id}, %{"goal_id" => g2.id}],+ strict_order?: false+ )++ lv = get_liveview(conn, site)++ lv+ |> element(~s/button[phx-click="edit-funnel"][phx-value-funnel-id="#{funnel.id}"]/)+ |> render_click()++ assert lv = find_live_child(lv, "funnels-form")++ lv+ |> element(~s/button#toggle-strict-order-switch[phx-click="toggle-strict-order"]/)+ |> render_click()++ lv+ |> element(~s/form/)+ |> render_submit()++ assert %Plausible.Funnel{strict_order: true} =+ Plausible.Funnels.get(site, "Editable strict funnel")+ end+test "funnel gets evaluated on every select, assuming a second has passed between selections",%{conn: conn,