Skip to content

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

Add burst rate limit (#6013)

Artur Pata446c48a7cb58
diff --git a/config/ce.exs b/config/ce.exs
index 9e2381d640..fb4cecbcfd 100644
--- a/config/ce.exs
+++ b/config/ce.exs
@@ -16,4 +16,7 @@ config :esbuild,
env: %{"NODE_PATH" => Path.expand("../deps", __DIR__)}
]
-config :plausible, Plausible.Auth.ApiKey, legacy_per_user_hourly_request_limit: 1_000_000
+config :plausible, Plausible.Auth.ApiKey,
+ legacy_per_user_hourly_request_limit: 1_000_000,
+ burst_request_limit: 1_000_000,
+ burst_period_seconds: 10
diff --git a/config/config.exs b/config/config.exs
index 326858d2d6..719fb1eca6 100644
--- a/config/config.exs
+++ b/config/config.exs
@@ -88,6 +88,9 @@ config :sentry,
config :prom_ex, :storage_adapter, Plausible.PromEx.StripedPeep
config :peep, :bucket_calculator, Plausible.PromEx.Buckets
-config :plausible, Plausible.Auth.ApiKey, legacy_per_user_hourly_request_limit: 600
+config :plausible, Plausible.Auth.ApiKey,
+ legacy_per_user_hourly_request_limit: 600,
+ burst_request_limit: 60,
+ burst_period_seconds: 10
import_config "#{config_env()}.exs"
diff --git a/config/test.exs b/config/test.exs
index 1fcf16c553..17f97b1398 100644
--- a/config/test.exs
+++ b/config/test.exs
@@ -62,8 +62,6 @@ config :plausible, Plausible.InstallationSupport.Checks.VerifyInstallation,
plug: {Req.Test, Plausible.InstallationSupport.Checks.VerifyInstallation}
]
-config :plausible, Plausible.Auth.ApiKey, legacy_per_user_hourly_request_limit: 100
-
config :plausible, Plausible.Session.Salts, interval: :timer.hours(1)
config :plausible, max_goals_per_site: 10
diff --git a/lib/plausible/auth/api_key.ex b/lib/plausible/auth/api_key.ex
index 529768c9e8..80334e38d0 100644
--- a/lib/plausible/auth/api_key.ex
+++ b/lib/plausible/auth/api_key.ex
@@ -57,16 +57,28 @@ defmodule Plausible.Auth.ApiKey do
timestamps()
end
+ defp config(), do: Application.fetch_env!(:plausible, __MODULE__)
+
def default_hourly_request_limit(), do: @default_hourly_request_limit_per_team
def limit_key(team), do: "api_request:team:#{team.identifier}"
def legacy_hourly_request_limit() do
- Application.fetch_env!(:plausible, __MODULE__)
+ config()
|> Keyword.fetch!(:legacy_per_user_hourly_request_limit)
end
def legacy_limit_key(user), do: "api_request:legacy_user:#{user.id}"
+ def burst_request_limit(),
+ do:
+ config()
+ |> Keyword.fetch!(:burst_request_limit)
+
+ def burst_period_seconds(),
+ do:
+ config()
+ |> Keyword.fetch!(:burst_period_seconds)
+
def changeset(struct, team, attrs) when not is_nil(team) do
struct
|> cast(attrs, @required ++ @optional)
diff --git a/lib/plausible_web/plugs/authorize_public_api.ex b/lib/plausible_web/plugs/authorize_public_api.ex
index d14538c4eb..e0efb9c0e1 100644
--- a/lib/plausible_web/plugs/authorize_public_api.ex
+++ b/lib/plausible_web/plugs/authorize_public_api.ex
@@ -54,6 +54,7 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPI do
with {:ok, token} <- get_bearer_token(conn),
{:ok, api_key, limit_key, hourly_limit} <- find_api_key(conn, token, context),
:ok <- check_api_key_rate_limit(limit_key, hourly_limit),
+ :ok <- check_api_key_burst_limit(limit_key),
{:ok, conn} <- verify_by_scope(conn, api_key, requested_scope) do
conn
|> assign(:current_user, api_key.user)
@@ -185,8 +186,30 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPI do
defp check_api_key_rate_limit(limit_key, hourly_limit) do
case RateLimit.check_rate(limit_key, to_timeout(hour: 1), hourly_limit) do
- {:allow, _} -> :ok
- {:deny, _} -> {:error, :rate_limit, hourly_limit}
+ {:allow, _} ->
+ :ok
+
+ {:deny, _} ->
+ {:error, :rate_limit,
+ "Too many API requests. The limit is #{hourly_limit} per hour. Please contact us to request more capacity."}
+ end
+ end
+
+ defp check_api_key_burst_limit(limit_key) do
+ burst_period_seconds = Auth.ApiKey.burst_period_seconds()
+ burst_request_limit = Auth.ApiKey.burst_request_limit()
+
+ case RateLimit.check_rate(
+ limit_key,
+ to_timeout(second: burst_period_seconds),
+ burst_request_limit
+ ) do
+ {:allow, _} ->
+ :ok
+
+ {:deny, _} ->
+ {:error, :rate_limit,
+ "Too many API requests in a short period of time. The limit is #{burst_request_limit} per #{burst_period_seconds} seconds. Please throttle your requests."}
end
end
@@ -319,10 +342,10 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPI do
)
end
- defp send_error(conn, _, {:error, :rate_limit, limit}) do
+ defp send_error(conn, _, {:error, :rate_limit, message}) do
H.too_many_requests(
conn,
- "Too many API requests. Your API key is limited to #{limit} requests per hour. Please contact us to request more capacity."
+ message
)
end
diff --git a/test/plausible_web/controllers/api/external_stats_controller/auth_test.exs b/test/plausible_web/controllers/api/external_stats_controller/auth_test.exs
index c121078e8b..8feda9e944 100644
--- a/test/plausible_web/controllers/api/external_stats_controller/auth_test.exs
+++ b/test/plausible_web/controllers/api/external_stats_controller/auth_test.exs
@@ -129,7 +129,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController.AuthTest do
|> get("/api/v1/stats/aggregate", %{"site_id" => site.domain})
|> assert_error(
429,
- "Too many API requests. Your API key is limited to 3 requests per hour."
+ "Too many API requests. The limit is 3 per hour. Please contact us to request more capacity."
)
end
diff --git a/test/plausible_web/plugs/authorize_public_api_test.exs b/test/plausible_web/plugs/authorize_public_api_test.exs
index cbb622cdd1..21a0baeffc 100644
--- a/test/plausible_web/plugs/authorize_public_api_test.exs
+++ b/test/plausible_web/plugs/authorize_public_api_test.exs
@@ -198,7 +198,7 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPITest do
end
test "halts with error when API lacks required scope", %{conn: conn} do
- user = insert(:user)
+ user = new_user()
api_key = insert_api_key(unquote(key_type), user: user)
conn =
@@ -208,10 +208,70 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPITest do
assert json_response(conn, 401)["error"] =~ "Invalid API key."
end
+ test "halts with error when over burst request limit" do
+ user = new_user()
+ api_key = insert_api_key(unquote(key_type), user: user, scopes: ["sites:read:*"])
+
+ 1..Plausible.Auth.ApiKey.burst_request_limit()
+ |> Enum.map(fn _ ->
+ conn =
+ get_fresh_conn()
+ |> authorize(api_key, api_scope: "sites:read:*")
+
+ refute conn.halted
+ assert conn.assigns.current_user.id == user.id
+ end)
+
+ conn =
+ get_fresh_conn() |> authorize(api_key, api_scope: "sites:read:*")
+
+ assert conn.halted
+
+ assert json_response(conn, 429)["error"] ==
+ "Too many API requests in a short period of time. The limit is 60 per 10 seconds. Please throttle your requests."
+ end
+
+ test "halts with error when over hourly request limit" do
+ # the lower value is ignored in the test
+ {legacy_hourly_limit, team_hourly_limit} =
+ case unquote(key_type) do
+ :legacy_api_key -> {100, 1}
+ :team_scope_api_key -> {1, 100}
+ end
+
+ patch_env(Plausible.Auth.ApiKey,
+ legacy_per_user_hourly_request_limit: legacy_hourly_limit,
+ # relax burst request limit to check hourly request limit
+ burst_request_limit: 200,
+ burst_period_seconds: 30
+ )
+
+ user = new_user(team: [hourly_api_request_limit: team_hourly_limit])
+ api_key = insert_api_key(unquote(key_type), user: user)
+
+ 1..100
+ |> Enum.map(fn _ ->
+ conn =
+ get_fresh_conn()
+ |> authorize(api_key, api_scope: "sites:read:*")
+
+ refute conn.halted
+ assert conn.assigns.current_user.id == user.id
+ end)
+
+ conn =
+ get_fresh_conn() |> authorize(api_key, api_scope: "sites:read:*")
+
+ assert conn.halted
+
+ assert json_response(conn, 429)["error"] ==
+ "Too many API requests. The limit is 100 per hour. Please contact us to request more capacity."
+ end
+
test "passes and sets current user when valid API key with required scope provided", %{
conn: conn
} do
- user = insert(:user)
+ user = new_user()
api_key = insert_api_key(unquote(key_type), user: user, scopes: ["sites:provision:*"])
conn =
@@ -255,7 +315,7 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPITest do
end
test "passes for subscope match", %{conn: conn} do
- user = insert(:user)
+ user = new_user()
api_key = insert_api_key(unquote(key_type), user: user, scopes: ["funnels:*"])
conn =
@@ -282,13 +342,19 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPITest do
assert conn.assigns.current_user.id == legacy_api_key_user.id
end
- @legacy_hourly_request_limit Plausible.Auth.ApiKey.legacy_hourly_request_limit()
- test "legacy API key requests are rate limited to configured #{@legacy_hourly_request_limit} requests per hour _per user_, but their team's team-scoped keys are on an independent rate limit" do
+ test "legacy API key requests are rate limited to configured requests per hour _per user_, but their team's team-scoped keys are on an independent rate limit" do
+ patch_env(Plausible.Auth.ApiKey,
+ legacy_per_user_hourly_request_limit: 100,
+ # relax burst request limit to check hourly request limit
+ burst_request_limit: 200,
+ burst_period_seconds: 30
+ )
+
legacy_api_key_user = new_user()
_site = new_site(owner: legacy_api_key_user)
legacy_api_key = insert_api_key(:legacy_api_key, user: legacy_api_key_user)
- 1..@legacy_hourly_request_limit
+ 1..Plausible.Auth.ApiKey.legacy_hourly_request_limit()
|> Enum.map(fn _ ->
conn =
get_fresh_conn()
@@ -306,7 +372,9 @@ defmodule PlausibleWeb.Plugs.AuthorizePublicAPITest do
|> authorize(api_key, api_scope: "sites:read:*")
assert conn.halted
- assert json_response(conn, 429)["error"] =~ "Too many API requests."
+
+ assert json_response(conn, 429)["error"] ==
+ "Too many API requests. The limit is 100 per hour. Please contact us to request more capacity."
end)
# no context API requests made with legacy API keys don't count towards team limits