matches_member support for custom props

Author: macobo

lib/plausible/stats/base.ex

@@ -551,5 +551,14 @@ defmodule Plausible.Stats.Base do
     )
   end
 
-  defp filter_by_custom_prop(_, q), do: q
+  defp filter_by_custom_prop({"event:props:" <> prop_name, {:matches_member, clauses}}, q) do
+    regexes = Enum.map(clauses, &page_regex/1)
+
+    from(
+      e in q,
+      where:
+        has_key(e, :meta, ^prop_name) and
+          fragment("arrayExists(k -> match(?, k), ?)", get_by_key(e, :meta, ^prop_name), ^regexes)
+    )
+  end
 end

lib/plausible/stats/breakdown.ex

@@ -194,6 +194,7 @@ defmodule Plausible.Stats.Breakdown do
   defp include_none_result?({:member, values}), do: Enum.member?(values, "(none)")
   defp include_none_result?({:not_member, values}), do: !Enum.member?(values, "(none)")
   defp include_none_result?({:matches, _}), do: false
+  defp include_none_result?({:matches_member, _}), do: false
   defp include_none_result?(_), do: true
 
   defp breakdown_sessions(_, _, _, [], _), do: []

test/plausible_web/controllers/api/external_stats_controller/timeseries_test.exs

@@ -857,6 +857,47 @@ defmodule PlausibleWeb.Api.ExternalStatsController.TimeseriesTest do
       assert first == %{"date" => "2021-01-01", "visitors" => 1}
       assert second == %{"date" => "2021-01-02", "visitors" => 0}
     end
+
+    test "filter by multiple custom event properties matching", %{conn: conn, site: site} do
+      populate_stats(site, [
+        build(:event,
+          name: "Purchase",
+          "meta.key": ["package", "browser"],
+          "meta.value": ["business", "Chrome"],
+          timestamp: ~N[2021-01-01 00:00:00]
+        ),
+        build(:event,
+          name: "Purchase",
+          "meta.key": ["package", "browser"],
+          "meta.value": ["business", "Firefox"],
+          timestamp: ~N[2021-01-01 00:00:00]
+        ),
+        build(:event,
+          name: "Purchase",
+          "meta.key": ["package", "browser"],
+          "meta.value": ["personal", "Safari"],
+          timestamp: ~N[2021-01-02 00:25:00]
+        ),
+        build(:event,
+          name: "Purchase",
+          "meta.key": ["package"],
+          "meta.value": ["business"],
+          timestamp: ~N[2021-01-02 00:25:00]
+        )
+      ])
+
+      conn =
+        get(conn, "/api/v1/stats/timeseries", %{
+          "site_id" => site.domain,
+          "period" => "month",
+          "date" => "2021-01-01",
+          "filters" => "event:name==Purchase;event:props:browser==F*|S*"
+        })
+
+      %{"results" => [first, second | _rest]} = json_response(conn, 200)
+      assert first == %{"date" => "2021-01-01", "visitors" => 1}
+      assert second == %{"date" => "2021-01-02", "visitors" => 1}
+    end
   end
 
   describe "metrics" do

test/plausible_web/controllers/api/stats_controller/pages_test.exs

@@ -112,6 +112,49 @@ defmodule PlausibleWeb.Api.StatsController.PagesTest do
              ]
     end
 
+    test "returns top pages with :matches_member filter on custom pageview props", %{
+      conn: conn,
+      site: site
+    } do
+      populate_stats(site, [
+        build(:pageview,
+          pathname: "/1",
+          "meta.key": ["prop"],
+          "meta.value": ["bar"]
+        ),
+        build(:pageview,
+          pathname: "/2",
+          "meta.key": ["prop"],
+          "meta.value": ["foobar"]
+        ),
+        build(:pageview,
+          pathname: "/3",
+          "meta.key": ["prop"],
+          "meta.value": ["baar"]
+        ),
+        build(:pageview,
+          pathname: "/4",
+          "meta.key": ["another"],
+          "meta.value": ["bar"]
+        ),
+        build(:pageview, pathname: "/5"),
+        build(:pageview,
+          pathname: "/6",
+          "meta.key": ["prop"],
+          "meta.value": ["near"]
+        )
+      ])
+
+      filters = Jason.encode!(%{props: %{"prop" => "~bar|nea"}})
+      conn = get(conn, "/api/stats/#{site.domain}/pages?period=day&filters=#{filters}")
+
+      assert json_response(conn, 200) == [
+               %{"visitors" => 1, "name" => "/1"},
+               %{"visitors" => 1, "name" => "/2"},
+               %{"visitors" => 1, "name" => "/6"}
+             ]
+    end
+
     test "returns top pages with multiple filters on custom pageview props", %{
       conn: conn,
       site: site