Remove LegacyDashboardFilterParser (#4882)

* Remove LegacyDashboardFilterParser usage in stats_controller

* Update tests to avoid legacy dashboard parsing

* Update top stats tests

Note a few behavioral test changes since dashboard doesn't do wildcards anymore

* Update test/plausible_web/controllers/stats_controller_test.exs

* Update sources_test

Removed test was dead functionality

* Update countries_test.exs

* Update test/plausible_web/controllers/api/stats_controller/browsers_test.exs

* Update test/plausible_web/controllers/api/stats_controller/custom_prop_breakdown_test.exs

* Update test/plausible_web/controllers/api/stats_controller/suggestions_test.exs

* Remove dead tests

* Update pages_test

* Update conversions_test.exs

* Update funnels_test.exs

* Update test/plausible_web/controllers/api/stats_controller/main_graph_test.exs

* Update test/plausible_web/controllers/api/stats_controller/suggestions_test.exs

* Update test/plausible/stats/query_test.exs

* Remove legacy parsing code

* Changelog

* Inline utils

CHANGELOG.md

@@ -9,6 +9,9 @@ All notable changes to this project will be documented in this file.
 - Support for `case_sensitive: false` modifiers in Stats API V2 filters for case-insensitive searches.
 
 ### Removed
+
+- Internal stats API routes no longer support legacy dashboard filter format.
+
 ### Changed
 
 - Details modal search inputs are now case-insensitive.

lib/plausible/stats/filters/filters.ex

@@ -4,7 +4,7 @@ defmodule Plausible.Stats.Filters do
   """
 
   alias Plausible.Stats.Filters.QueryParser
-  alias Plausible.Stats.Filters.{LegacyDashboardFilterParser, StatsAPIFilterParser}
+  alias Plausible.Stats.Filters.StatsAPIFilterParser
 
   @visit_props [
     :source,
@@ -52,17 +52,13 @@ defmodule Plausible.Stats.Filters do
 
   Depending on the format and type of the `filters` argument, returns:
 
-    * a decoded list, when `filters` is encoded JSON
     * a parsed filter list, when `filters` is a filter expression string
     * the same list, when `filters` is a map
 
   Returns an empty list when argument type is unexpected (e.g. `nil`).
 
   ### Examples:
 
-      iex> Filters.parse("{\\"page\\":\\"/blog/**\\"}")
-      [[:matches_wildcard, "event:page", ["/blog/**"]]]
-
       iex> Filters.parse("visit:browser!=Chrome")
       [[:is_not, "visit:browser", ["Chrome"]]]
 
@@ -71,15 +67,12 @@ defmodule Plausible.Stats.Filters do
   """
   def parse(filters) when is_binary(filters) do
     case Jason.decode(filters) do
-      {:ok, filters} when is_map(filters) or is_list(filters) -> parse(filters)
+      {:ok, filters} when is_list(filters) -> parse(filters)
       {:ok, _} -> []
       {:error, err} -> StatsAPIFilterParser.parse_filter_expression(err.data)
     end
   end
 
-  def parse(filters) when is_map(filters),
-    do: LegacyDashboardFilterParser.parse_and_prefix(filters)
-
   def parse(filters) when is_list(filters) do
     {:ok, parsed_filters} = QueryParser.parse_filters(filters)
     parsed_filters

lib/plausible/stats/filters/stats_api_filter_parser.ex

@@ -1,7 +1,7 @@
 defmodule Plausible.Stats.Filters.StatsAPIFilterParser do
   @moduledoc false
 
-  import Plausible.Stats.Filters.Utils
+  @non_escaped_pipe_regex ~r/(?<!\\)\|/
 
   @doc """
   This function parses the filter expression given as a string.
@@ -70,4 +70,22 @@ defmodule Plausible.Stats.Filters.StatsAPIFilterParser do
 
     [:is, key, List.wrap(value)]
   end
+
+  defp list_expression?(expression) do
+    Regex.match?(@non_escaped_pipe_regex, expression)
+  end
+
+  defp wildcard_expression?(expression) do
+    String.contains?(expression, "*")
+  end
+
+  defp parse_member_list(raw_value) do
+    raw_value
+    |> String.split(@non_escaped_pipe_regex)
+    |> Enum.map(&remove_escape_chars/1)
+  end
+
+  defp remove_escape_chars(value) do
+    String.replace(value, "\\|", "|")
+  end
 end

lib/plausible/stats/filters/utils.ex

@@ -1,28 +1,5 @@
 defmodule Plausible.Stats.Filters.Utils do
-  @moduledoc """
-  Contains utility functions shared between `LegacyDashboardFilterParser`
-  and `StatsAPIFilterParser`.
-  """
-
-  @non_escaped_pipe_regex ~r/(?<!\\)\|/
-
-  def list_expression?(expression) do
-    Regex.match?(@non_escaped_pipe_regex, expression)
-  end
-
-  def wildcard_expression?(expression) do
-    String.contains?(expression, "*")
-  end
-
-  def parse_member_list(raw_value) do
-    raw_value
-    |> String.split(@non_escaped_pipe_regex)
-    |> Enum.map(&remove_escape_chars/1)
-  end
-
-  def remove_escape_chars(value) do
-    String.replace(value, "\\|", "|")
-  end
+  @moduledoc false
 
   def split_goals(goals) do
     Enum.split_with(goals, fn goal -> Plausible.Goal.type(goal) == :event end)

lib/plausible_web/controllers/api/stats_controller.ex

@@ -6,7 +6,6 @@ defmodule PlausibleWeb.Api.StatsController do
 
   alias Plausible.Stats
   alias Plausible.Stats.{Query, Comparisons, Filters, Time, TableDecider}
-  alias Plausible.Stats.Filters.LegacyDashboardFilterParser
   alias PlausibleWeb.Api.Helpers, as: H
 
   require Logger
@@ -803,11 +802,9 @@ defmodule PlausibleWeb.Api.StatsController do
     site = conn.assigns[:site]
     params = Map.put(params, "property", "visit:referrer")
 
-    referrer_filter = LegacyDashboardFilterParser.filter_value("visit:source", referrer)
-
     query =
       Query.from(site, params, debug_metadata(conn))
-      |> Query.add_filter(referrer_filter)
+      |> Query.add_filter([:is, "visit:source", [referrer]])
 
     pagination = parse_pagination(params)