From 3738cd95781e8e0ebef1587b5d4c1be8ba57f7e5 Mon Sep 17 00:00:00 2001 From: Adrian Gruntkowski Date: Thu, 1 Feb 2024 10:27:11 +0100 Subject: [PATCH] Parse referrer filter value when passed separately (#3742) * Parse referrer filter value when passed separately * Remove unnecessary test setup --- .../stats/filters/dashboard_filter_parser.ex | 15 +++++---- lib/plausible/stats/query.ex | 9 +++++- .../controllers/api/stats_controller.ex | 4 +-- .../api/stats_controller/sources_test.exs | 32 +++++++++++++++++++ 4 files changed, 50 insertions(+), 10 deletions(-) diff --git a/lib/plausible/stats/filters/dashboard_filter_parser.ex b/lib/plausible/stats/filters/dashboard_filter_parser.ex index 22293d4c9..041fa836e 100644 --- a/lib/plausible/stats/filters/dashboard_filter_parser.ex +++ b/lib/plausible/stats/filters/dashboard_filter_parser.ex @@ -26,13 +26,8 @@ defmodule Plausible.Stats.Filters.DashboardFilterParser do end) end - defp put_parsed_props(new_filters, name, val) do - Enum.reduce(val, new_filters, fn {prop_key, prop_val}, new_filters -> - Map.put(new_filters, "event:props:" <> prop_key, filter_value(name, prop_val)) - end) - end - - defp filter_value(key, val) do + @spec filter_value(String.t(), String.t()) :: {atom(), String.t() | [String.t()]} + def filter_value(key, val) do {is_negated, val} = parse_negated_prefix(val) {is_contains, val} = parse_contains_prefix(val) is_list = list_expression?(val) @@ -57,6 +52,12 @@ defmodule Plausible.Stats.Filters.DashboardFilterParser do end end + defp put_parsed_props(new_filters, name, val) do + Enum.reduce(val, new_filters, fn {prop_key, prop_val}, new_filters -> + Map.put(new_filters, "event:props:" <> prop_key, filter_value(name, prop_val)) + end) + end + defp parse_negated_prefix("!" <> val), do: {true, val} defp parse_negated_prefix(val), do: {false, val} diff --git a/lib/plausible/stats/query.ex b/lib/plausible/stats/query.ex index cdbd2bd31..bf87dfa8a 100644 --- a/lib/plausible/stats/query.ex +++ b/lib/plausible/stats/query.ex @@ -168,8 +168,15 @@ defmodule Plausible.Stats.Query do end def put_filter(query, key, val) do + parsed_val = + if is_binary(val) do + Filters.DashboardFilterParser.filter_value(key, val) + else + val + end + struct!(query, - filters: Map.put(query.filters, key, val) + filters: Map.put(query.filters, key, parsed_val) ) end diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index 8247020c1..2632ef625 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -709,7 +709,7 @@ defmodule PlausibleWeb.Api.StatsController do query = Query.from(site, params) - |> Query.put_filter("visit:source", {:is, "Google"}) + |> Query.put_filter("visit:source", "Google") search_terms = if site.google_auth && site.google_auth.property && !query.filters["goal"] do @@ -744,7 +744,7 @@ defmodule PlausibleWeb.Api.StatsController do query = Query.from(site, params) - |> Query.put_filter("visit:source", {:is, referrer}) + |> Query.put_filter("visit:source", referrer) pagination = parse_pagination(params) diff --git a/test/plausible_web/controllers/api/stats_controller/sources_test.exs b/test/plausible_web/controllers/api/stats_controller/sources_test.exs index 7a6f2a100..c3735e946 100644 --- a/test/plausible_web/controllers/api/stats_controller/sources_test.exs +++ b/test/plausible_web/controllers/api/stats_controller/sources_test.exs @@ -1458,6 +1458,38 @@ defmodule PlausibleWeb.Api.StatsController.SourcesTest do } end + test "works when filter expression is provided for source", %{ + conn: conn, + site: site + } do + populate_stats(site, [ + build(:pageview, + referrer_source: "DuckDuckGo", + referrer: "duckduckgo.com" + ), + build(:pageview, + referrer_source: "Google", + referrer: "google.com" + ), + build(:pageview, + referrer_source: "Google", + referrer: "google.com" + ) + ]) + + conn = get(conn, "/api/stats/#{site.domain}/referrers/!Google?period=day") + + assert json_response(conn, 200) == [ + %{"name" => "duckduckgo.com", "visitors" => 1} + ] + + conn = get(conn, "/api/stats/#{site.domain}/referrers/Google|DuckDuckGo?period=day") + + assert [entry1, entry2] = json_response(conn, 200) + assert %{"name" => "google.com", "visitors" => 2} in [entry1, entry2] + assert %{"name" => "duckduckgo.com", "visitors" => 1} in [entry1, entry2] + end + test "returns top referring urls for a custom goal", %{conn: conn, site: site} do populate_stats(site, [ build(:pageview,