Skip to content

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

Validate the same metric isnt queried multiple times in external stats API (#3871)

Karl-Aksel Puulmanna9d3c03782dd
diff --git a/CHANGELOG.md b/CHANGELOG.md
index d4cf7dc41c..72b16e29bf 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -43,6 +43,7 @@ All notable changes to this project will be documented in this file.
- Require custom properties to be explicitly added from Site Settings > Custom Properties in order for them to show up on the dashboard
- GA/SC sections moved to new settings: Integrations
- Replace `CLICKHOUSE_MAX_BUFFER_SIZE` with `CLICKHOUSE_MAX_BUFFER_SIZE_BYTES`
+- Validate metric isn't queried multiple times
### Fixed
- Using `VersionedCollapsingMergeTree` to store visit data to avoid rare race conditions that led to wrong visit data being shown
diff --git a/lib/plausible_web/controllers/api/external_stats_controller.ex b/lib/plausible_web/controllers/api/external_stats_controller.ex
index c9cc9af837..b2a82e5019 100644
--- a/lib/plausible_web/controllers/api/external_stats_controller.ex
+++ b/lib/plausible_web/controllers/api/external_stats_controller.ex
@@ -111,7 +111,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController do
Map.get(params, "metrics", "visitors")
|> String.split(",")
- case validate_all_metrics(metrics, property, query) do
+ case validate_metrics(metrics, property, query) do
{:error, reason} ->
{:error, reason}
@@ -149,7 +149,15 @@ defmodule PlausibleWeb.Api.ExternalStatsController do
end
end
- defp validate_all_metrics(metrics, property, query) do
+ defp validate_metrics(metrics, property, query) do
+ if length(metrics) == length(Enum.uniq(metrics)) do
+ validate_each_metric(metrics, property, query)
+ else
+ {:error, "Metrics cannot be queried multiple times."}
+ end
+ end
+
+ defp validate_each_metric(metrics, property, query) do
Enum.reduce_while(metrics, [], fn metric, acc ->
case validate_metric(metric, property, query) do
{:ok, metric} -> {:cont, acc ++ [metric]}
diff --git a/test/plausible_web/controllers/api/external_stats_controller/aggregate_test.exs b/test/plausible_web/controllers/api/external_stats_controller/aggregate_test.exs
index c8db66d576..e6d8a0dd17 100644
--- a/test/plausible_web/controllers/api/external_stats_controller/aggregate_test.exs
+++ b/test/plausible_web/controllers/api/external_stats_controller/aggregate_test.exs
@@ -189,6 +189,21 @@ defmodule PlausibleWeb.Api.ExternalStatsController.AggregateTest do
"Session metric `views_per_visit` cannot be queried when using a filter on `event:name`."
}
end
+
+ test "validates a metric isn't asked multiple times", %{
+ conn: conn,
+ site: site
+ } do
+ conn =
+ get(conn, "/api/v1/stats/aggregate", %{
+ "site_id" => site.domain,
+ "metrics" => "visitors,visitors"
+ })
+
+ assert json_response(conn, 400) == %{
+ "error" => "Metrics cannot be queried multiple times."
+ }
+ end
end
test "aggregates a single metric", %{conn: conn, site: site} do