From 0194d57b382bf39cbbde79bcfa826ac87fe7d49b Mon Sep 17 00:00:00 2001 From: RobertJoonas <56999674+RobertJoonas@users.noreply.github.com> Date: Fri, 16 Sep 2022 10:21:44 +0300 Subject: [PATCH] add upper bound to limit parameter (#2226) * add upper bound to limit parameter * add more strict validation for limit parameter + 2 tests * update changelog --- CHANGELOG.md | 1 + .../api/external_stats_controller.ex | 17 +++++++-- .../breakdown_test.exs | 35 +++++++++++++++++++ 3 files changed, 51 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a113ea4d7..bc0c1675a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ All notable changes to this project will be documented in this file. ## Unreleased ### Added +- An upper bound of 1000 to the `limit` parameter in Stats API - The `exclusions` script extension now also takes a `data-include` attribute tag - A `file-downloads` script extension for automatically tracking file downloads as custom events - Integration with [Matomo's referrer spam list](https://github.com/matomo-org/referrer-spam-list/blob/master/spammers.txt) to block known spammers diff --git a/lib/plausible_web/controllers/api/external_stats_controller.ex b/lib/plausible_web/controllers/api/external_stats_controller.ex index 554a1e509..cf6dca78c 100644 --- a/lib/plausible_web/controllers/api/external_stats_controller.ex +++ b/lib/plausible_web/controllers/api/external_stats_controller.ex @@ -62,8 +62,8 @@ defmodule PlausibleWeb.Api.ExternalStatsController do :ok <- validate_date(params), {:ok, property} <- validate_property(params), query <- Query.from(site, params), - {:ok, metrics} <- parse_metrics(params, property, query) do - limit = String.to_integer(Map.get(params, "limit", "100")) + {:ok, metrics} <- parse_metrics(params, property, query), + {:ok, limit} <- validate_or_default_limit(params) do page = String.to_integer(Map.get(params, "page", "1")) results = Plausible.Stats.breakdown(site, query, property, metrics, {limit, page}) @@ -96,6 +96,19 @@ defmodule PlausibleWeb.Api.ExternalStatsController do "The `property` parameter is required. Please provide at least one property to show a breakdown by."} end + @max_breakdown_limit 1000 + defp validate_or_default_limit(%{"limit" => limit}) do + with {limit, ""} when limit > 0 and limit <= @max_breakdown_limit <- Integer.parse(limit) do + {:ok, limit} + else + _ -> + {:error, "Please provide limit as a number between 1 and #{@max_breakdown_limit}."} + end + end + + @default_breakdown_limit 100 + defp validate_or_default_limit(_), do: {:ok, @default_breakdown_limit} + defp event_only_property?("event:name"), do: true defp event_only_property?("event:props:" <> _), do: true defp event_only_property?(_), do: false diff --git a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs index e6b41b03e..308d750a0 100644 --- a/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs +++ b/test/plausible_web/controllers/api/external_stats_controller/breakdown_test.exs @@ -1567,6 +1567,41 @@ defmodule PlausibleWeb.Api.ExternalStatsController.BreakdownTest do assert Enum.count(res["results"]) == 2 end + @invalid_limit_message "Please provide limit as a number between 1 and 1000." + + test "returns error when limit too large", %{conn: conn, site: site} do + conn = + get(conn, "/api/v1/stats/breakdown", %{ + "site_id" => site.domain, + "property" => "event:page", + "limit" => 1001 + }) + + assert json_response(conn, 400) == %{"error" => @invalid_limit_message} + end + + test "returns error with non-integer limit", %{conn: conn, site: site} do + conn = + get(conn, "/api/v1/stats/breakdown", %{ + "site_id" => site.domain, + "property" => "event:page", + "limit" => "bad_limit" + }) + + assert json_response(conn, 400) == %{"error" => @invalid_limit_message} + end + + test "returns error with negative integer limit", %{conn: conn, site: site} do + conn = + get(conn, "/api/v1/stats/breakdown", %{ + "site_id" => site.domain, + "property" => "event:page", + "limit" => -1 + }) + + assert json_response(conn, 400) == %{"error" => @invalid_limit_message} + end + test "can paginate results", %{conn: conn, site: site} do populate_stats([ build(:pageview, pathname: "/a", domain: site.domain, timestamp: ~N[2021-01-01 00:00:00]),