From 0a64dc44df4854908fe13f140395bb9c35c26268 Mon Sep 17 00:00:00 2001 From: Robert Joonas Date: Wed, 5 Apr 2023 22:36:03 +0100 Subject: [PATCH] support member and not_member filter types for pageview props --- lib/plausible/stats/base.ex | 30 ++++++- .../breakdown_test.exs | 88 +++++++++++++++++++ .../api/stats_controller/pages_test.exs | 80 +++++++++++++++++ 3 files changed, 195 insertions(+), 3 deletions(-) diff --git a/lib/plausible/stats/base.ex b/lib/plausible/stats/base.ex index 02436a8c3..8273d1ce0 100644 --- a/lib/plausible/stats/base.ex +++ b/lib/plausible/stats/base.ex @@ -175,9 +175,33 @@ defmodule Plausible.Stats.Base do ) end - _ -> - q - end + {"event:props:" <> prop_name, {:member, values}} -> + none_value_included = Enum.member?(values, "(none)") + + from( + e in q, + left_lateral_join: meta in "meta", + as: :meta, + where: + (meta.key == ^prop_name and meta.value in ^values) or + (^none_value_included and fragment("not has(?, ?)", field(e, :"meta.key"), ^prop_name)) + ) + + {"event:props:" <> prop_name, {:not_member, values}} -> + none_value_included = Enum.member?(values, "(none)") + + from( + e in q, + left_lateral_join: meta in "meta", + as: :meta, + where: + (meta.key == ^prop_name and meta.value not in ^values) or + (^none_value_included and fragment("has(?, ?)", field(e, :"meta.key"), ^prop_name) and meta.value not in ^values) or + (not ^none_value_included and fragment("not has(?, ?)", field(e, :"meta.key"), ^prop_name)) + ) + + _ -> q + end q end diff --git a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs index f60d3d762..5d7fca704 100644 --- a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs +++ b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs @@ -1481,6 +1481,94 @@ defmodule PlausibleWeb.Api.ExternalStatsController.BreakdownTest do } end + test "IN filter for event:props:*", %{conn: conn, site: site} do + populate_stats(site, [ + build(:pageview, + browser: "Chrome", + "meta.key": ["browser"], + "meta.value": ["Chrome"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + browser: "Chrome", + "meta.key": ["browser"], + "meta.value": ["Chrome"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + browser: "Safari", + "meta.key": ["browser"], + "meta.value": ["Safari"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + browser: "Firefox", + "meta.key": ["browser"], + "meta.value": ["Firefox"], + timestamp: ~N[2021-01-01 00:00:00] + ) + ]) + + conn = + get(conn, "/api/v1/stats/breakdown", %{ + "site_id" => site.domain, + "period" => "day", + "date" => "2021-01-01", + "property" => "visit:browser", + "filters" => "event:props:browser == Chrome|Safari" + }) + + assert json_response(conn, 200) == %{ + "results" => [ + %{"browser" => "Chrome", "visitors" => 2}, + %{"browser" => "Safari", "visitors" => 1}, + ] + } + end + + test "IN filter for event:props:* including (none) value", %{conn: conn, site: site} do + populate_stats(site, [ + build(:pageview, + browser: "Chrome", + "meta.key": ["browser"], + "meta.value": ["Chrome"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + browser: "Chrome", + "meta.key": ["browser"], + "meta.value": ["Chrome"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + browser: "Safari", + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + browser: "Firefox", + "meta.key": ["browser"], + "meta.value": ["Firefox"], + timestamp: ~N[2021-01-01 00:00:00] + ) + ]) + + conn = + get(conn, "/api/v1/stats/breakdown", %{ + "site_id" => site.domain, + "period" => "day", + "date" => "2021-01-01", + "property" => "visit:browser", + "filters" => "event:props:browser == Chrome|(none)" + }) + + assert json_response(conn, 200) == %{ + "results" => [ + %{"browser" => "Chrome", "visitors" => 2}, + %{"browser" => "Safari", "visitors" => 1}, + ] + } + end + test "can use a is_not filter", %{conn: conn, site: site} do populate_stats(site, [ build(:pageview, browser: "Chrome"), 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 c549bb516..ead78cfbd 100644 --- a/test/plausible_web/controllers/api/stats_controller/pages_test.exs +++ b/test/plausible_web/controllers/api/stats_controller/pages_test.exs @@ -307,6 +307,86 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do ] end + test "returns top pages with :not_member filter on custom pageview props", %{conn: conn, site: site} do + populate_stats(site, [ + build(:pageview, + pathname: "/chrome", + "meta.key": ["browser"], + "meta.value": ["Chrome"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + pathname: "/chrome", + "meta.key": ["browser"], + "meta.value": ["Chrome"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + pathname: "/safari", + "meta.key": ["browser"], + "meta.value": ["Safari"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + pathname: "/firefox", + "meta.key": ["browser"], + "meta.value": ["Firefox"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + pathname: "/firefox", + timestamp: ~N[2021-01-01 00:00:00] + ) + ]) + + filters = Jason.encode!(%{props: %{"browser" => "!Chrome|Safari"}}) + conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}") + + assert json_response(conn, 200) == [ + %{ + "name" => "/firefox", + "visitors" => 2 + } + ] + end + + test "returns top pages with :not_member filter on custom pageview props including (none) value", %{conn: conn, site: site} do + populate_stats(site, [ + build(:pageview, + pathname: "/chrome", + "meta.key": ["browser"], + "meta.value": ["Chrome"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + pathname: "/chrome", + "meta.key": ["browser"], + "meta.value": ["Chrome"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + pathname: "/safari", + "meta.key": ["browser"], + "meta.value": ["Safari"], + timestamp: ~N[2021-01-01 00:00:00] + ), + build(:pageview, + pathname: "/no-browser-prop", + timestamp: ~N[2021-01-01 00:00:00] + ) + ]) + + filters = Jason.encode!(%{props: %{"browser" => "!Chrome|(none)"}}) + conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&date=2021-01-01&filters=#{filters}") + + assert json_response(conn, 200) == [ + %{ + "name" => "/safari", + "visitors" => 1 + } + ] + end + test "calculates bounce_rate and time_on_page for pages filtered by page path", %{conn: conn, site: site} do populate_stats(site, [