Skip to content

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

Add feature flag to block event ingest (#1991)

Uku Taht292a419473d8
diff --git a/lib/plausible_web/controllers/api/external_controller.ex b/lib/plausible_web/controllers/api/external_controller.ex
index b1d1970e71..fb83348a67 100644
--- a/lib/plausible_web/controllers/api/external_controller.ex
+++ b/lib/plausible_web/controllers/api/external_controller.ex
@@ -118,9 +118,12 @@ defmodule PlausibleWeb.Api.ExternalController do
end
blacklist_domain = params["domain"] in Application.get_env(:plausible, :domain_blacklist)
- referrer_spam = is_spammer?(params["referrer"])
- if is_bot?(ua) || blacklist_domain || referrer_spam do
+ blocked_via_flag? = fn ->
+ FunWithFlags.enabled?(:block_event_ingest, for: params["domain"])
+ end
+
+ if blacklist_domain || is_bot?(ua) || is_spammer?(params["referrer"]) || blocked_via_flag?.() do
:ok
else
uri = params["url"] && URI.parse(params["url"])
diff --git a/mix.exs b/mix.exs
index ee474e5e10..b465712050 100644
--- a/mix.exs
+++ b/mix.exs
@@ -105,7 +105,8 @@ defmodule Plausible.MixProject do
{:opentelemetry_phoenix, "~> 1.0"},
{:telemetry, "~> 1.0", override: true},
{:opentelemetry_ecto, "~> 1.0.0"},
- {:observer_cli, "~> 1.7"}
+ {:observer_cli, "~> 1.7"},
+ {:mimic, "~> 1.7", only: :test}
]
end
diff --git a/mix.lock b/mix.lock
index 894fe4637f..e615277917 100644
--- a/mix.lock
+++ b/mix.lock
@@ -59,6 +59,7 @@
"metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm", "69b09adddc4f74a40716ae54d140f93beb0fb8978d8636eaded0c31b6f099f16"},
"mime": {:hex, :mime, "1.6.0", "dabde576a497cef4bbdd60aceee8160e02a6c89250d6c0b29e56c0dfb00db3d2", [:mix], [], "hexpm", "31a1a8613f8321143dde1dafc36006a17d28d02bdfecb9e95a880fa7aabd19a7"},
"mimerl": {:hex, :mimerl, "1.2.0", "67e2d3f571088d5cfd3e550c383094b47159f3eee8ffa08e64106cdf5e981be3", [:rebar3], [], "hexpm", "f278585650aa581986264638ebf698f8bb19df297f66ad91b18910dfc6e19323"},
+ "mimic": {:hex, :mimic, "1.7.2", "27007e4e0c746ddb6d56a386c40585088b35621ae2d7167160e8c3283e8cd585", [:mix], [], "hexpm", "e4d40550523841055aa469f5125d124ab89ce8b2d3686cab908b98dff5e6111b"},
"mmdb2_decoder": {:hex, :mmdb2_decoder, "3.0.0", "54828676a36e75e9a25bc9a0bb0598d4c7fcc767bf0b40674850b22e05b7b6cc", [:mix], [], "hexpm", "359dc9242915538d1dceb9f6d96c72201dca76ce62e49d22e2ed1e86f20bea8e"},
"nanoid": {:hex, :nanoid, "2.0.5", "1d2948d8967ef2d948a58c3fef02385040bd9823fc6394bd604b8d98e5516b22", [:mix], [], "hexpm", "956e8876321104da72aa48770539ff26b36b744cd26753ec8e7a8a37e53d5f58"},
"oauther": {:hex, :oauther, "1.3.0", "82b399607f0ca9d01c640438b34d74ebd9e4acd716508f868e864537ecdb1f76", [:mix], [], "hexpm", "78eb888ea875c72ca27b0864a6f550bc6ee84f2eeca37b093d3d833fbcaec04e"},
diff --git a/test/plausible_web/controllers/api/external_controller_test.exs b/test/plausible_web/controllers/api/external_controller_test.exs
index cd345e1367..d13b09f904 100644
--- a/test/plausible_web/controllers/api/external_controller_test.exs
+++ b/test/plausible_web/controllers/api/external_controller_test.exs
@@ -1,5 +1,6 @@
defmodule PlausibleWeb.Api.ExternalControllerTest do
use PlausibleWeb.ConnCase
+ use Mimic
use Plausible.ClickhouseRepo
defp get_event(domain) do
@@ -265,6 +266,30 @@ defmodule PlausibleWeb.Api.ExternalControllerTest do
assert !get_event("ignore-spammers-test.com")
end
+ test "feature flag - blocks traffic from a domain when block_traffic is enabled", %{
+ conn: conn
+ } do
+ FunWithFlags
+ |> stub(:enabled?, fn
+ :block_event_ingest, [for: "feature-flag-test.com"] -> true
+ _, _ -> false
+ end)
+
+ params = %{
+ domain: "feature-flag-test.com",
+ name: "pageview",
+ url: "https://feature-flag-test.com"
+ }
+
+ conn =
+ conn
+ |> put_req_header("user-agent", @user_agent)
+ |> post("/api/event", params)
+
+ assert response(conn, 202) == "ok"
+ refute get_event("feature-flag-test.com")
+ end
+
test "ignores when referrer is internal", %{conn: conn} do
params = %{
name: "pageview",
diff --git a/test/test_helper.exs b/test/test_helper.exs
index 884d934070..78603315c3 100644
--- a/test/test_helper.exs
+++ b/test/test_helper.exs
@@ -1,5 +1,6 @@
{:ok, _} = Application.ensure_all_started(:ex_machina)
Plausible.Test.ClickhouseSetup.run()
+Mimic.copy(FunWithFlags)
ExUnit.start()
Application.ensure_all_started(:double)
Ecto.Adapters.SQL.Sandbox.mode(Plausible.Repo, :manual)