diff --git a/lib/plausible/stats/breakdown.ex b/lib/plausible/stats/breakdown.ex index 7a89633a2..4eba54b77 100644 --- a/lib/plausible/stats/breakdown.ex +++ b/lib/plausible/stats/breakdown.ex @@ -68,12 +68,10 @@ defmodule Plausible.Stats.Breakdown do {limit, _} = pagination none_result = - if !Enum.any?(query.filters, fn {key, _} -> String.starts_with?(key, "event:props") end) do - none_filters = Map.put(query.filters, "event:props:" <> custom_prop, {:is, "(none)"}) - none_query = %Query{query | filters: none_filters} + if include_none_result?(query.filters[property]) do + none_query = Query.put_filter(query, property, {:is, "(none)"}) from(e in base_event_query(site, none_query), - order_by: [desc: fragment("uniq(?)", e.user_id)], select: %{}, select_merge: %{^custom_prop => "(none)"}, having: fragment("uniq(?)", e.user_id) > 0 @@ -85,14 +83,15 @@ defmodule Plausible.Stats.Breakdown do end trace(query, property, metrics) - results = breakdown_events(site, query, "event:props:" <> custom_prop, metrics, pagination) - - zipped = zip_results(none_result, results, custom_prop, metrics) + results = + breakdown_events(site, query, "event:props:" <> custom_prop, metrics, pagination) + |> Kernel.++(none_result) + |> Enum.sort_by(&(&1[sorting_key(metrics)]), :desc) - if Enum.find_index(zipped, fn value -> value[custom_prop] == "(none)" end) == limit do - Enum.slice(zipped, 0..(limit - 1)) + if Enum.find_index(results, fn value -> value[custom_prop] == "(none)" end) == limit do + Enum.slice(results, 0..(limit - 1)) else - zipped + results end end @@ -174,6 +173,12 @@ defmodule Plausible.Stats.Breakdown do |> Enum.sort_by(&(&1[sorting_key(metrics)]), :desc) end + defp include_none_result?({:is, value}), do: value == "(none)" + defp include_none_result?({:is_not, "(none)"}), do: false + defp include_none_result?({:member, values}), do: Enum.member?(values, "(none)") + defp include_none_result?({:not_member, values}), do: !Enum.member?(values, "(none)") + defp include_none_result?(_), do: true + defp breakdown_sessions(_, _, _, [], _), do: [] defp breakdown_sessions(site, query, property, metrics, pagination) do diff --git a/lib/plausible/stats/props.ex b/lib/plausible/stats/props.ex index cc8b6856d..c7081ff73 100644 --- a/lib/plausible/stats/props.ex +++ b/lib/plausible/stats/props.ex @@ -30,24 +30,11 @@ defmodule Plausible.Stats.Props do def valid_prop?(_), do: false def props(site, query) do - prop_filter = - Enum.find(query.filters, fn {key, _} -> String.starts_with?(key, "event:props:") end) - - case prop_filter do - {"event:props:" <> key, {_, "(none)"}} -> + case Plausible.Stats.Query.get_filter_by_prefix(query, "event:props:") do + {"event:props:" <> key, _} -> {_, {_, goal_name}} = query.filters["event:goal"] %{goal_name => [key]} - {"event:props:" <> _key, _} -> - ClickhouseRepo.all( - from [e, meta: meta] in base_event_query(site, query), - select: {e.name, meta.key}, - distinct: true - ) - |> Enum.reduce(%{}, fn {goal_name, meta_key}, acc -> - Map.update(acc, goal_name, [meta_key], fn list -> [meta_key | list] end) - end) - nil -> ClickhouseRepo.all( from e in base_event_query(site, query), diff --git a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs b/test/plausible_web/controllers/api/stats_controller/conversions_test.exs index e6a0626c2..3aa3ceb2a 100644 --- a/test/plausible_web/controllers/api/stats_controller/conversions_test.exs +++ b/test/plausible_web/controllers/api/stats_controller/conversions_test.exs @@ -249,6 +249,44 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do ] end + test "returns only the prop name for the property in filter", %{ + conn: conn, + site: site + } do + populate_stats(site, [ + build(:event, + name: "Payment", + "meta.key": ["logged_in"], + "meta.value": ["true"] + ), + build(:event, + name: "Payment", + "meta.key": ["logged_in"], + "meta.value": ["false"] + ), + build(:event, + name: "Payment", + "meta.key": ["author"], + "meta.value": ["John"] + ), + ]) + + insert(:goal, %{site: site, event_name: "Payment"}) + + filters = Jason.encode!(%{goal: "Payment", props: %{"logged_in" => "true|(none)"}}) + conn = get(conn, "/api/stats/#{site.domain}/conversions?period=day&filters=#{filters}") + + assert json_response(conn, 200) == [ + %{ + "name" => "Payment", + "unique_conversions" => 2, + "total_conversions" => 2, + "prop_names" => ["logged_in"], + "conversion_rate" => 66.7 + } + ] + end + test "can filter by multiple mixed goals", %{conn: conn, site: site} do populate_stats(site, [ build(:pageview, pathname: "/"), @@ -519,6 +557,357 @@ defmodule PlausibleWeb.Api.StatsController.ConversionsTest do ] end + test "does not return (none) value in property breakdown with is filter on prop_value", %{conn: conn, site: site} do + populate_stats(site, [ + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["0"] + ), + build(:event, name: "Purchase") + ]) + + insert(:goal, %{site: site, event_name: "Purchase"}) + + filters = + Jason.encode!(%{ + goal: "Purchase", + props: %{cost: "0"} + }) + + conn = + get( + conn, + "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{ + "name" => "0", + "unique_conversions" => 1, + "total_conversions" => 1, + "conversion_rate" => 50.0 + }, + ] + end + + test "returns only (none) value in property breakdown with is (none) filter", %{conn: conn, site: site} do + populate_stats(site, [ + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["0"] + ), + build(:event, name: "Purchase") + ]) + + insert(:goal, %{site: site, event_name: "Purchase"}) + + filters = + Jason.encode!(%{ + goal: "Purchase", + props: %{cost: "(none)"} + }) + + conn = + get( + conn, + "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{ + "name" => "(none)", + "unique_conversions" => 1, + "total_conversions" => 1, + "conversion_rate" => 50.0 + }, + ] + end + + test "returns (none) value in property breakdown with is_not filter on prop_value", %{conn: conn, site: site} do + populate_stats(site, [ + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["0"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["20"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["20"] + ), + build(:event, name: "Purchase") + ]) + + insert(:goal, %{site: site, event_name: "Purchase"}) + + filters = + Jason.encode!(%{ + goal: "Purchase", + props: %{cost: "!0"} + }) + + conn = + get( + conn, + "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{ + "name" => "20", + "unique_conversions" => 2, + "total_conversions" => 2, + "conversion_rate" => 50.0 + }, + %{ + "name" => "(none)", + "unique_conversions" => 1, + "total_conversions" => 1, + "conversion_rate" => 25.0 + }, + ] + end + + test "does not return (none) value in property breakdown with is_not (none) filter", %{conn: conn, site: site} do + populate_stats(site, [ + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["0"] + ), + build(:event, name: "Purchase") + ]) + + insert(:goal, %{site: site, event_name: "Purchase"}) + + filters = + Jason.encode!(%{ + goal: "Purchase", + props: %{cost: "!(none)"} + }) + + conn = + get( + conn, + "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{ + "name" => "0", + "unique_conversions" => 1, + "total_conversions" => 1, + "conversion_rate" => 50.0 + }, + ] + end + + test "does not return (none) value in property breakdown with member filter on prop_value", %{conn: conn, site: site} do + populate_stats(site, [ + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["0"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["1"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["1"] + ), + build(:event, name: "Purchase") + ]) + + insert(:goal, %{site: site, event_name: "Purchase"}) + + filters = + Jason.encode!(%{ + goal: "Purchase", + props: %{cost: "0|1"} + }) + + conn = + get( + conn, + "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{ + "name" => "1", + "unique_conversions" => 2, + "total_conversions" => 2, + "conversion_rate" => 50.0 + }, + %{ + "name" => "0", + "unique_conversions" => 1, + "total_conversions" => 1, + "conversion_rate" => 25.0 + }, + ] + end + + test "returns (none) value in property breakdown with member filter including a (none) value", %{conn: conn, site: site} do + populate_stats(site, [ + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["0"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["1"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["1"] + ), + build(:event, name: "Purchase") + ]) + + insert(:goal, %{site: site, event_name: "Purchase"}) + + filters = + Jason.encode!(%{ + goal: "Purchase", + props: %{cost: "1|(none)"} + }) + + conn = + get( + conn, + "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{ + "name" => "1", + "unique_conversions" => 2, + "total_conversions" => 2, + "conversion_rate" => 50.0 + }, + %{ + "name" => "(none)", + "unique_conversions" => 1, + "total_conversions" => 1, + "conversion_rate" => 25.0 + }, + ] + end + + test "returns (none) value in property breakdown with not_member filter on prop_value", %{conn: conn, site: site} do + populate_stats(site, [ + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["0"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["0.01"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["20"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["20"] + ), + build(:event, name: "Purchase") + ]) + + insert(:goal, %{site: site, event_name: "Purchase"}) + + filters = + Jason.encode!(%{ + goal: "Purchase", + props: %{cost: "!0|0.01"} + }) + + conn = + get( + conn, + "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{ + "name" => "20", + "unique_conversions" => 2, + "total_conversions" => 2, + "conversion_rate" => 40.0 + }, + %{ + "name" => "(none)", + "unique_conversions" => 1, + "total_conversions" => 1, + "conversion_rate" => 20.0 + }, + ] + end + + test "does not return (none) value in property breakdown with not_member filter including a (none) value", %{conn: conn, site: site} do + populate_stats(site, [ + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["0"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["20"] + ), + build(:event, + name: "Purchase", + "meta.key": ["cost"], + "meta.value": ["20"] + ), + build(:event, name: "Purchase") + ]) + + insert(:goal, %{site: site, event_name: "Purchase"}) + + filters = + Jason.encode!(%{ + goal: "Purchase", + props: %{cost: "!0|(none)"} + }) + + conn = + get( + conn, + "/api/stats/#{site.domain}/property/cost?period=day&filters=#{filters}" + ) + + assert json_response(conn, 200) == [ + %{ + "name" => "20", + "unique_conversions" => 2, + "total_conversions" => 2, + "conversion_rate" => 50.0 + }, + ] + end + test "property breakdown with prop filter", %{conn: conn, site: site} do populate_stats(site, [ build(:pageview, user_id: 1),