Stats API: allow escaping `|` literal character with `\|` when filtering (#2266)
* add separate module for filter parsing * add tests for filter parser * allow escaping pipe character in filter value * add documentation and doctests * do not remove escape chars from wildcard values * changelog update * change the parse_filters/1 function argumentpull/2273/head
parent
620e29ab33
commit
155e274150
@ -0,0 +1,80 @@
|
||||
defmodule Plausible.Stats.FilterParser do
|
||||
@moduledoc """
|
||||
A module for parsing filters used in stat queries.
|
||||
"""
|
||||
|
||||
@doc """
|
||||
Parses different filter formats.
|
||||
|
||||
Depending on the format and type of the `filters` argument, returns:
|
||||
|
||||
* a decoded map, when `filters` is encoded JSON
|
||||
* a parsed filter map, when `filters` is a filter expression string
|
||||
* the same map, when `filters` is a map
|
||||
|
||||
Returns an empty map when argument type is unexpected (e.g. `nil`).
|
||||
|
||||
### Examples:
|
||||
|
||||
iex> FilterParser.parse_filters("{\\"page\\":\\"/blog/**\\"}")
|
||||
%{"page" => "/blog/**"}
|
||||
|
||||
iex> FilterParser.parse_filters("visit:browser!=Chrome")
|
||||
%{"visit:browser" => {:is_not, "Chrome"}}
|
||||
|
||||
iex> FilterParser.parse_filters(nil)
|
||||
%{}
|
||||
"""
|
||||
def parse_filters(filters) when is_binary(filters) do
|
||||
case Jason.decode(filters) do
|
||||
{:ok, parsed} -> parsed
|
||||
{:error, err} -> parse_filter_expression(err.data)
|
||||
end
|
||||
end
|
||||
|
||||
def parse_filters(filters) when is_map(filters), do: filters
|
||||
def parse_filters(_), do: %{}
|
||||
|
||||
defp parse_filter_expression(str) do
|
||||
filters = String.split(str, ";")
|
||||
|
||||
Enum.map(filters, &parse_single_filter/1)
|
||||
|> Enum.into(%{})
|
||||
end
|
||||
|
||||
@non_escaped_pipe_regex ~r/(?<!\\)\|/
|
||||
defp parse_single_filter(str) do
|
||||
[key, raw_value] =
|
||||
String.trim(str)
|
||||
|> String.split(["==", "!="], trim: true)
|
||||
|> Enum.map(&String.trim/1)
|
||||
|
||||
is_negated = String.contains?(str, "!=")
|
||||
is_list = Regex.match?(@non_escaped_pipe_regex, raw_value)
|
||||
is_wildcard = String.contains?(raw_value, "*")
|
||||
|
||||
final_value = remove_escape_chars(raw_value)
|
||||
|
||||
cond do
|
||||
key == "event:goal" -> {key, parse_goal_filter(final_value)}
|
||||
is_wildcard && is_negated -> {key, {:does_not_match, raw_value}}
|
||||
is_wildcard -> {key, {:matches, raw_value}}
|
||||
is_list -> {key, {:member, parse_member_list(raw_value)}}
|
||||
is_negated -> {key, {:is_not, final_value}}
|
||||
true -> {key, {:is, final_value}}
|
||||
end
|
||||
end
|
||||
|
||||
defp parse_goal_filter("Visit " <> page), do: {:is, :page, page}
|
||||
defp parse_goal_filter(event), do: {:is, :event, event}
|
||||
|
||||
defp remove_escape_chars(value) do
|
||||
String.replace(value, "\\|", "|")
|
||||
end
|
||||
|
||||
defp parse_member_list(raw_value) do
|
||||
raw_value
|
||||
|> String.split(@non_escaped_pipe_regex)
|
||||
|> Enum.map(&remove_escape_chars/1)
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,80 @@
|
||||
defmodule Plausible.Stats.FilterParserTest do
|
||||
use ExUnit.Case, async: true
|
||||
alias Plausible.Stats.FilterParser
|
||||
|
||||
doctest Plausible.Stats.FilterParser
|
||||
|
||||
def assert_parsed(input, expected_output) do
|
||||
assert FilterParser.parse_filters(input) == expected_output
|
||||
end
|
||||
|
||||
describe "parses filter expression" do
|
||||
test "simple positive" do
|
||||
"event:name==pageview"
|
||||
|> assert_parsed(%{"event:name" => {:is, "pageview"}})
|
||||
end
|
||||
|
||||
test "simple negative" do
|
||||
"event:name!=pageview"
|
||||
|> assert_parsed(%{"event:name" => {:is_not, "pageview"}})
|
||||
end
|
||||
|
||||
test "whitespace is trimmed" do
|
||||
" event:name == pageview "
|
||||
|> assert_parsed(%{"event:name" => {:is, "pageview"}})
|
||||
end
|
||||
|
||||
test "wildcard" do
|
||||
"event:page==/blog/post-*"
|
||||
|> assert_parsed(%{"event:page" => {:matches, "/blog/post-*"}})
|
||||
end
|
||||
|
||||
test "negative wildcard" do
|
||||
"event:page!=/blog/post-*"
|
||||
|> assert_parsed(%{"event:page" => {:does_not_match, "/blog/post-*"}})
|
||||
end
|
||||
|
||||
test "custom event goal" do
|
||||
"event:goal==Signup"
|
||||
|> assert_parsed(%{"event:goal" => {:is, :event, "Signup"}})
|
||||
end
|
||||
|
||||
test "pageview goal" do
|
||||
"event:goal==Visit /blog"
|
||||
|> assert_parsed(%{"event:goal" => {:is, :page, "/blog"}})
|
||||
end
|
||||
|
||||
test "member" do
|
||||
"visit:country==FR|GB|DE"
|
||||
|> assert_parsed(%{"visit:country" => {:member, ["FR", "GB", "DE"]}})
|
||||
end
|
||||
|
||||
test "member + wildcard" do
|
||||
"event:page==/blog**|/newsletter|/*/"
|
||||
|> assert_parsed(%{"event:page" => {:matches, "/blog**|/newsletter|/*/"}})
|
||||
end
|
||||
|
||||
test "combined with \";\"" do
|
||||
"event:page==/blog**|/newsletter|/*/ ; visit:country==FR|GB|DE"
|
||||
|> assert_parsed(%{
|
||||
"event:page" => {:matches, "/blog**|/newsletter|/*/"},
|
||||
"visit:country" => {:member, ["FR", "GB", "DE"]}
|
||||
})
|
||||
end
|
||||
|
||||
test "escaping pipe character" do
|
||||
"utm_campaign==campaign \\| 1"
|
||||
|> assert_parsed(%{"utm_campaign" => {:is, "campaign | 1"}})
|
||||
end
|
||||
|
||||
test "escaping pipe character in member filter" do
|
||||
"utm_campaign==campaign \\| 1|campaign \\| 2"
|
||||
|> assert_parsed(%{"utm_campaign" => {:member, ["campaign | 1", "campaign | 2"]}})
|
||||
end
|
||||
|
||||
test "keeps escape characters in member + wildcard filter" do
|
||||
"event:page==/**\\|page|/other/page"
|
||||
|> assert_parsed(%{"event:page" => {:matches, "/**\\|page|/other/page"}})
|
||||
end
|
||||
end
|
||||
end
|
||||
Loading…
Reference in New Issue