Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Add `custom_props.csv` back to CSV export for Growth plans (#3656)

RobertJoonas1342135908d3
diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex
index cccb5f2539..8492716758 100644
--- a/lib/plausible_web/controllers/api/stats_controller.ex
+++ b/lib/plausible_web/controllers/api/stats_controller.ex
@@ -1214,21 +1214,30 @@ defmodule PlausibleWeb.Api.StatsController do
prop_names = Plausible.Stats.CustomProps.fetch_prop_names(site, query)
- values =
- prop_names
- |> Enum.map(fn prop_key ->
- breakdown_custom_prop_values(site, Map.put(params, "prop_key", prop_key))
- |> Enum.map(&Map.put(&1, :property, prop_key))
- |> transform_keys(%{:name => :value})
- end)
- |> Enum.concat()
+ prop_names =
+ if Plausible.Billing.Feature.Props.enabled?(site) do
+ prop_names
+ else
+ prop_names |> Enum.filter(&(&1 in Plausible.Props.internal_keys()))
+ end
- percent_or_cr =
- if query.filters["event:goal"],
- do: :conversion_rate,
- else: :percentage
+ if not Enum.empty?(prop_names) do
+ values =
+ prop_names
+ |> Enum.map(fn prop_key ->
+ breakdown_custom_prop_values(site, Map.put(params, "prop_key", prop_key))
+ |> Enum.map(&Map.put(&1, :property, prop_key))
+ |> transform_keys(%{:name => :value})
+ end)
+ |> Enum.concat()
+
+ percent_or_cr =
+ if query.filters["event:goal"],
+ do: :conversion_rate,
+ else: :percentage
- to_csv(values, [:property, :value, :visitors, :events, percent_or_cr])
+ to_csv(values, [:property, :value, :visitors, :events, percent_or_cr])
+ end
end
defp breakdown_custom_prop_values(site, %{"prop_key" => prop_key} = params) do
diff --git a/lib/plausible_web/controllers/stats_controller.ex b/lib/plausible_web/controllers/stats_controller.ex
index b6bee8b116..e0e5fda39b 100644
--- a/lib/plausible_web/controllers/stats_controller.ex
+++ b/lib/plausible_web/controllers/stats_controller.ex
@@ -159,18 +159,10 @@ defmodule PlausibleWeb.StatsController do
~c"operating_systems.csv" => fn -> Api.StatsController.operating_systems(conn, params) end,
~c"devices.csv" => fn -> Api.StatsController.screen_sizes(conn, params) end,
~c"conversions.csv" => fn -> Api.StatsController.conversions(conn, params) end,
- ~c"referrers.csv" => fn -> Api.StatsController.referrers(conn, params) end
+ ~c"referrers.csv" => fn -> Api.StatsController.referrers(conn, params) end,
+ ~c"custom_props.csv" => fn -> Api.StatsController.all_custom_prop_values(conn, params) end
}
- csvs =
- if Plausible.Billing.Feature.Props.enabled?(site) do
- Map.put(csvs, ~c"custom_props.csv", fn ->
- Api.StatsController.all_custom_prop_values(conn, params)
- end)
- else
- csvs
- end
-
csv_values =
Map.values(csvs)
|> Plausible.ClickhouseRepo.parallel_tasks()
@@ -178,6 +170,7 @@ defmodule PlausibleWeb.StatsController do
csvs =
Map.keys(csvs)
|> Enum.zip(csv_values)
+ |> Enum.reject(fn {_k, v} -> is_nil(v) end)
csvs = [{~c"visitors.csv", visitors} | csvs]
diff --git a/test/plausible_web/controllers/stats_controller_test.exs b/test/plausible_web/controllers/stats_controller_test.exs
index b33d87457c..0cb5473797 100644
--- a/test/plausible_web/controllers/stats_controller_test.exs
+++ b/test/plausible_web/controllers/stats_controller_test.exs
@@ -146,7 +146,6 @@ defmodule PlausibleWeb.StatsControllerTest do
assert ~c"cities.csv" in zip
assert ~c"conversions.csv" in zip
assert ~c"countries.csv" in zip
- assert ~c"custom_props.csv" in zip
assert ~c"devices.csv" in zip
assert ~c"entry_pages.csv" in zip
assert ~c"exit_pages.csv" in zip
@@ -161,15 +160,54 @@ defmodule PlausibleWeb.StatsControllerTest do
assert ~c"utm_terms.csv" in zip
end
- test "does not export custom properties when site owner is on a growth plan", %{
+ test "exports only internally used props in custom_props.csv for a growth plan", %{
conn: conn,
- site: site,
- user: user
+ site: site
} do
- insert(:growth_subscription, user: user)
- response = conn |> get("/" <> site.domain <> "/export") |> response(200)
+ {:ok, site} = Plausible.Props.allow(site, ["author"])
+
+ site = Repo.preload(site, :owner)
+ insert(:growth_subscription, user: site.owner)
+ populate_stats(site, [
+ build(:pageview, "meta.key": ["author"], "meta.value": ["a"]),
+ build(:event, name: "File Download", "meta.key": ["url"], "meta.value": ["b"])
+ ])
+
+ conn = get(conn, "/" <> site.domain <> "/export?period=day")
+ assert response = response(conn, 200)
{:ok, zip} = :zip.unzip(response, [:memory])
+
+ {_filename, result} =
+ Enum.find(zip, fn {filename, _data} -> filename == ~c"custom_props.csv" end)
+
+ assert parse_csv(result) == [
+ ["property", "value", "visitors", "events", "percentage"],
+ ["url", "b", "1", "1", "50.0"],
+ ["url", "(none)", "1", "1", "50.0"],
+ [""]
+ ]
+ end
+
+ test "does not include custom_props.csv for a growth plan if no internal props used", %{
+ conn: conn,
+ site: site
+ } do
+ {:ok, site} = Plausible.Props.allow(site, ["author"])
+
+ site = Repo.preload(site, :owner)
+ insert(:growth_subscription, user: site.owner)
+
+ populate_stats(site, [
+ build(:pageview, "meta.key": ["author"], "meta.value": ["a"])
+ ])
+
+ {:ok, zip} =
+ conn
+ |> get("/#{site.domain}/export?period=day")
+ |> response(200)
+ |> :zip.unzip([:memory])
+
files = Map.new(zip)
refute Map.has_key?(files, ~c"custom_props.csv")
@@ -190,7 +228,7 @@ defmodule PlausibleWeb.StatsControllerTest do
|> response(400)
end
- test "exports allowed event props", %{conn: conn, site: site} do
+ test "exports allowed event props for a trial account", %{conn: conn, site: site} do
{:ok, site} = Plausible.Props.allow(site, ["author", "logged_in"])
populate_stats(site, [