From a9b16fa6c656dcb81e003a45970256c2a9ae2a1d Mon Sep 17 00:00:00 2001 From: Uku Taht Date: Thu, 19 Aug 2021 10:32:03 +0300 Subject: [PATCH] Fix exit rate when filtering for page --- lib/plausible/stats/aggregate.ex | 1 + lib/plausible/stats/base.ex | 26 ++++-- lib/plausible/stats/breakdown.ex | 16 ---- lib/plausible/stats/clickhouse.ex | 1 + lib/plausible/stats/query.ex | 14 +-- .../controllers/api/stats_controller.ex | 1 + .../api/stats_controller/pages_test.exs | 86 +++++++++++++++++++ 7 files changed, 114 insertions(+), 31 deletions(-) diff --git a/lib/plausible/stats/aggregate.ex b/lib/plausible/stats/aggregate.ex index 38cd54ae4..061008253 100644 --- a/lib/plausible/stats/aggregate.ex +++ b/lib/plausible/stats/aggregate.ex @@ -42,6 +42,7 @@ defmodule Plausible.Stats.Aggregate do query = Query.treat_page_filter_as_entry_page(query) from(e in query_sessions(site, query), select: %{}) + |> filter_converted_sessions(site, query) |> select_session_metrics(metrics) |> ClickhouseRepo.one() end diff --git a/lib/plausible/stats/base.ex b/lib/plausible/stats/base.ex index 463c7e222..1a7aadd9e 100644 --- a/lib/plausible/stats/base.ex +++ b/lib/plausible/stats/base.ex @@ -7,7 +7,7 @@ defmodule Plausible.Stats.Base do def base_event_query(site, query) do events_q = query_events(site, query) - if Enum.any?(Filters.visit_props() ++ ["goal"], &query.filters["visit:" <> &1]) do + if Enum.any?(Filters.visit_props() ++ ["goal", "page"], &query.filters["visit:" <> &1]) do sessions_q = from( s in query_sessions(site, query), @@ -132,15 +132,15 @@ defmodule Plausible.Stats.Base do ) sessions_q = - case query.filters["visit:goal"] do - nil -> + case {query.filters["visit:goal"], query.filters["visit:page"]} do + {nil, nil} -> sessions_q - goal_filter -> + {goal_filter, page_filter} -> events_query = Query.put_filter(query, "event:goal", goal_filter) |> Query.put_filter("event:name", nil) - |> Query.put_filter("event:page", nil) + |> Query.put_filter("event:page", page_filter) events_q = from( @@ -294,6 +294,22 @@ defmodule Plausible.Stats.Base do |> select_event_metrics(rest) end + def filter_converted_sessions(db_query, site, query) do + if query.filters["event:name"] || query.filters["event:page"] || query.filters["event:goal"] do + converted_sessions = + from(e in query_events(site, query), + select: %{session_id: fragment("DISTINCT ?", e.session_id)} + ) + + from(s in db_query, + join: cs in subquery(converted_sessions), + on: s.session_id == cs.session_id + ) + else + db_query + end + end + defp db_prop_val("referrer_source", @no_ref), do: "" defp db_prop_val("utm_medium", @no_ref), do: "" defp db_prop_val("utm_source", @no_ref), do: "" diff --git a/lib/plausible/stats/breakdown.ex b/lib/plausible/stats/breakdown.ex index 70669320c..a7ab661a7 100644 --- a/lib/plausible/stats/breakdown.ex +++ b/lib/plausible/stats/breakdown.ex @@ -173,22 +173,6 @@ defmodule Plausible.Stats.Breakdown do |> ClickhouseRepo.all() end - defp filter_converted_sessions(db_query, site, query) do - if query.filters["event:name"] || query.filters["event:page"] || query.filters["event:goal"] do - converted_sessions = - from(e in query_events(site, query), - select: %{session_id: fragment("DISTINCT ?", e.session_id)} - ) - - from(s in db_query, - join: cs in subquery(converted_sessions), - on: s.session_id == cs.session_id - ) - else - db_query - end - end - defp breakdown_events(_, _, _, [], _), do: [] defp breakdown_events(site, query, property, metrics, {limit, page}) do diff --git a/lib/plausible/stats/clickhouse.ex b/lib/plausible/stats/clickhouse.ex index 60607f6a8..b15b94106 100644 --- a/lib/plausible/stats/clickhouse.ex +++ b/lib/plausible/stats/clickhouse.ex @@ -568,6 +568,7 @@ defmodule Plausible.Stats.Clickhouse do Map.put(r, :exit_rate, nil) end end) + |> IO.inspect() else result end diff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.ex index 37b059ecd..37c006e52 100644 --- a/lib/plausible/stats/query.ex +++ b/lib/plausible/stats/query.ex @@ -165,18 +165,12 @@ defmodule Plausible.Stats.Query do def treat_page_filter_as_entry_page(%__MODULE__{filters: %{"visit:entry_page" => _}} = q), do: q - def treat_page_filter_as_entry_page(query) do - case query.filters["event:page"] do - nil -> - query - - filter -> - query - |> put_filter("event:page", nil) - |> put_filter("visit:entry_page", filter) - end + def treat_page_filter_as_entry_page(%__MODULE__{filters: %{"event:page" => f}} = q) do + put_filter(q, "visit:entry_page", f) end + def treat_page_filter_as_entry_page(q), do: q + defp today(tz) do Timex.now(tz) |> Timex.to_date() end diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index ae32651d2..3b6f57e2a 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -369,6 +369,7 @@ defmodule PlausibleWeb.Api.StatsController do |> Query.put_filter("event:goal", nil) |> Query.put_filter("event:name", {:is, "pageview"}) |> Query.put_filter("visit:goal", query.filters["event:goal"]) + |> Query.put_filter("visit:page", query.filters["event:page"]) total_pageviews = Stats.breakdown(site, total_visits_query, "event:page", ["pageviews"], {limit, 1}) diff --git a/test/plausible_web/controllers/api/stats_controller/pages_test.exs b/test/plausible_web/controllers/api/stats_controller/pages_test.exs index 644184b9e..5606cfd20 100644 --- a/test/plausible_web/controllers/api/stats_controller/pages_test.exs +++ b/test/plausible_web/controllers/api/stats_controller/pages_test.exs @@ -167,5 +167,91 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do %{"name" => "/page2", "count" => 1, "exits" => 1, "exit_rate" => 100} ] end + + test "calculates correct exit rate when filtering for goal", %{conn: conn, site: site} do + populate_stats(site, [ + build(:event, + name: "Signup", + user_id: 1, + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + user_id: 1, + pathname: "/exit1", + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:event, + name: "Signup", + user_id: 2, + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + user_id: 2, + pathname: "/exit1", + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + user_id: 2, + pathname: "/exit2", + timestamp: ~N[2021-01-01 00:00:00] + ) + ]) + + filters = Jason.encode!(%{"goal" => "Signup"}) + + conn = + get( + conn, + "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{"name" => "/exit1", "count" => 1, "exits" => 1, "exit_rate" => 50}, + %{"name" => "/exit2", "count" => 1, "exits" => 1, "exit_rate" => 100} + ] + end + + test "calculates correct exit rate when filtering for page", %{conn: conn, site: site} do + populate_stats(site, [ + build(:pageview, + user_id: 1, + pathname: "/exit1", + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + user_id: 2, + pathname: "/exit1", + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + user_id: 2, + pathname: "/exit2", + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + user_id: 3, + pathname: "/exit2", + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + user_id: 3, + pathname: "/should-not-appear", + timestamp: ~N[2021-01-01 00:00:00] + ) + ]) + + filters = Jason.encode!(%{"page" => "/exit1"}) + + conn = + get( + conn, + "/api/stats/#{site.domain}/exit-pages?period=day&date=2021-01-01&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{"name" => "/exit1", "count" => 1, "exits" => 1, "exit_rate" => 50}, + %{"name" => "/exit2", "count" => 1, "exits" => 1, "exit_rate" => 100} + ] + end end end