Add tests

Author: apata

lib/plausible/stats/filters/filters.ex

@@ -57,7 +57,7 @@ defmodule Plausible.Stats.Filters do
 
   Returns an empty list when argument type is unexpected (e.g. `nil`).
 
-  ### Examples:
+  ## Examples:
 
       iex> Filters.parse("visit:browser!=Chrome")
       [[:is_not, "visit:browser", ["Chrome"]]]
@@ -128,6 +128,16 @@ defmodule Plausible.Stats.Filters do
   Transformer will receive each node (filter, and/or/not subtree) of
   query and must return a list of nodes to replace it with or nil
   to ignore and look deeper.
+
+  ## Examples
+
+    iex> Filters.transform_filters([[:is, "visit:entry_page", ["/blog"]]], fn f -> [f] end)
+    [[:is, "visit:entry_page", ["/blog"]]]
+
+    iex> Filters.transform_filters([[:is, "visit:entry_page", ["/blog"]]], fn _f -> nil end)
+    [[[:is, "visit:entry_page", ["/blog"]]]]
+
+
   """
   def transform_filters(filters, transformer) do
     filters

lib/plausible/stats/filters/query_parser.ex

@@ -452,6 +452,18 @@ defmodule Plausible.Stats.Filters.QueryParser do
     }
   end
 
+  @doc """
+  Finds unique segment IDs used in query filters.
+
+  ## Examples
+    iex> get_segment_ids([[:not, [:is, "segment", [10, 20]]], [:contains, "visit:entry_page", ["blog"]]])
+
+    {:ok, [10, 20]}
+
+    iex> get_segment_ids([[:and, [[:is, "segment", Enum.to_list(1..6)], [:is, "segment", Enum.to_list(1..6)]]]])
+
+    {:error, "Invalid filters. You can only use up to 10 segment filters in a query."}
+  """
   def get_segment_ids(filters) do
     max_segment_filters_count = 10
 
@@ -500,13 +512,37 @@ defmodule Plausible.Stats.Filters.QueryParser do
   end
 
   defp replace_segment_with_filter_tree([_, "segment", clauses], preloaded_segments) do
-    [[:or, Enum.map(clauses, fn id -> [:and, Map.get(preloaded_segments, id)] end)]]
+    if length(clauses) === 1 do
+      [[:and, Map.get(preloaded_segments, Enum.at(clauses, 0))]]
+    else
+      [[:or, Enum.map(clauses, fn id -> [:and, Map.get(preloaded_segments, id)] end)]]
+    end
   end
 
-  defp replace_segment_with_filter_tree(_filter_tree, _preloaded_segments) do
-    nil
+  defp replace_segment_with_filter_tree(filter, _preloaded_segments) do
+    [filter]
   end
 
+  @doc """
+  ## Examples
+
+    iex> resolve_segments([[:is, "visit:entry_page", ["/home"]]], %{})
+    {:ok, [[:is, "visit:entry_page", ["/home"]]]}
+
+    iex> resolve_segments([[:is, "visit:entry_page", ["/home"]], [:is, "segment", [1]]], %{1 => [[:contains, "visit:entry_page", ["blog"]], [:is, "visit:country", ["PL"]]]})
+    {:ok, [
+      [:is, "visit:entry_page", ["/home"]],
+      [:and, [[:contains, "visit:entry_page", ["blog"]], [:is, "visit:country", ["PL"]]]]
+    ]}
+
+    iex> resolve_segments([[:is, "segment", [1, 2]]], %{1 => [[:contains, "event:goal", ["Singup"]], [:is, "visit:country", ["PL"]]], 2 => [[:contains, "event:goal", ["Sauna"]], [:is, "visit:country", ["EE"]]]})
+    {:ok, [
+      [:or, [
+        [:and, [[:contains, "event:goal", ["Singup"]], [:is, "visit:country", ["PL"]]]],
+        [:and, [[:contains, "event:goal", ["Sauna"]], [:is, "visit:country", ["EE"]]]]]
+      ]
+    ]}
+  """
   def resolve_segments(original_filters, preloaded_segments) do
     if Map.keys(preloaded_segments) !== [] do
       {:ok,

test/plausible/stats/query_parser_test.exs

@@ -2,10 +2,11 @@ defmodule Plausible.Stats.Filters.QueryParserTest do
   use Plausible
   use Plausible.DataCase
   use Plausible.Teams.Test
+  import Plausible.Stats.Filters.QueryParser
+  doctest Plausible.Stats.Filters.QueryParser
 
   alias Plausible.Stats.DateTimeRange
   alias Plausible.Stats.Filters
-  import Plausible.Stats.Filters.QueryParser
 
   setup [:create_user, :create_site]