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
Add ability to filter by substring of "Direct / None" in `contains` (#5738)
Adrian Gruntkowski26a6a2e3af9f
diff --git a/lib/plausible/stats/sql/where_builder.ex b/lib/plausible/stats/sql/where_builder.exindex b7af6aaee8..33201e42ad 100644--- a/lib/plausible/stats/sql/where_builder.ex+++ b/lib/plausible/stats/sql/where_builder.ex@@ -294,7 +294,11 @@ defmodule Plausible.Stats.SQL.WhereBuilder doenddefp filter_field(db_field, [:contains | _rest] = filter) do- contains_clause(col_value_string(db_field), filter)+ if no_ref_field?(db_field) do+ contains_clause_no_ref(col_value_string(db_field), filter)+ else+ contains_clause(col_value_string(db_field), filter)+ endenddefp filter_field(db_field, [:contains_not | rest]) do@@ -327,6 +331,15 @@ defmodule Plausible.Stats.SQL.WhereBuilder dodefp db_field_name("channel"), do: :acquisition_channeldefp db_field_name(name), do: String.to_existing_atom(name)+ defp no_ref_field?(:source), do: true+ defp no_ref_field?(:referrer), do: true+ defp no_ref_field?(:utm_medium), do: true+ defp no_ref_field?(:utm_source), do: true+ defp no_ref_field?(:utm_campaign), do: true+ defp no_ref_field?(:utm_content), do: true+ defp no_ref_field?(:utm_term), do: true+ defp no_ref_field?(_), do: false+defp db_field_val(:source, @no_ref), do: ""defp db_field_val(:referrer, @no_ref), do: ""defp db_field_val(:utm_medium, @no_ref), do: ""@@ -375,6 +388,39 @@ defmodule Plausible.Stats.SQL.WhereBuilder doendend+ defp contains_clause_no_ref(value_expression, [_, _, clauses | _] = filter) do+ case_sensitive? = case_sensitive?(filter)++ expression =+ if case_sensitive? do+ dynamic(+ [x],+ fragment("multiSearchAny(?, ?)", ^value_expression, ^clauses)+ )+ else+ dynamic(+ [x],+ fragment("multiSearchAnyCaseInsensitive(?, ?)", ^value_expression, ^clauses)+ )+ end++ if Enum.any?(clauses, &matches_no_ref?(&1, case_sensitive?)) do+ dynamic([x], ^expression or fragment("? = ?", ^value_expression, ""))+ else+ expression+ end+ end+defp case_sensitive?([_, _, _, %{case_sensitive: false}]), do: falsedefp case_sensitive?(_), do: true++ @no_ref_downcase String.downcase(@no_ref)++ defp matches_no_ref?(input, false) do+ String.contains?(@no_ref_downcase, String.downcase(input))+ end++ defp matches_no_ref?(input, true) do+ String.contains?(@no_ref, input)+ endenddiff --git a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs b/test/plausible_web/controllers/api/external_stats_controller/query_test.exsindex e606eaceb1..7064d835dd 100644--- a/test/plausible_web/controllers/api/external_stats_controller/query_test.exs+++ b/test/plausible_web/controllers/api/external_stats_controller/query_test.exs@@ -1049,6 +1049,94 @@ defmodule PlausibleWeb.Api.ExternalStatsController.QueryTest doassert json_response(conn, 200)["results"] == [%{"metrics" => [3], "dimensions" => []}]end+ test "contains source filter with no ref value match", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, referrer: ""),+ build(:pageview, referrer_source: "Google"),+ build(:pageview, referrer_source: "https://DirectX.com")+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["visitors"],+ "filters" => [+ ["contains", "visit:source", ["Direct"]]+ ]+ })++ assert json_response(conn, 200)["results"] == [%{"metrics" => [2], "dimensions" => []}]+ end++ test "contains not source filter with no ref value match", %{conn: conn, site: site} do+ populate_stats(site, [+ build(:pageview, referrer: ""),+ build(:pageview, referrer_source: "Google"),+ build(:pageview, referrer_source: "https://DirectX.com")+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["visitors"],+ "filters" => [+ ["contains_not", "visit:source", ["Direct"]]+ ]+ })++ assert json_response(conn, 200)["results"] == [%{"metrics" => [1], "dimensions" => []}]+ end++ test "contains source filter with no ref value match combined with member filter", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:pageview, referrer: ""),+ build(:pageview, referrer_source: "Google"),+ build(:pageview, referrer_source: "Bing"),+ build(:pageview, referrer_source: "https://DirectX.com")+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["visitors"],+ "filters" => [+ ["contains", "visit:source", ["Direct", "Google"]]+ ]+ })++ assert json_response(conn, 200)["results"] == [%{"metrics" => [3], "dimensions" => []}]+ end++ test "contains source filter with no ref value match without case sensitivity", %{+ conn: conn,+ site: site+ } do+ populate_stats(site, [+ build(:pageview, referrer: ""),+ build(:pageview, referrer_source: "Google"),+ build(:pageview, referrer_source: "Bing"),+ build(:pageview, referrer_source: "https://DirectX.com")+ ])++ conn =+ post(conn, "/api/v2/query", %{+ "site_id" => site.domain,+ "date_range" => "all",+ "metrics" => ["visitors"],+ "filters" => [+ ["contains", "visit:source", ["direct"], %{"case_sensitive" => false}]+ ]+ })++ assert json_response(conn, 200)["results"] == [%{"metrics" => [2], "dimensions" => []}]+ end+test "`matches` operator", %{conn: conn, site: site} dopopulate_stats(site, [build(:pageview, pathname: "/user/1234"),