Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Script v2: Rate limit tech detection (#5701)
Artur Pata6a9fe4573c38
diff --git a/lib/plausible/installation_support/detection/checks.ex b/lib/plausible/installation_support/detection/checks.exindex 0b2110f6fc..002c371c32 100644--- a/lib/plausible/installation_support/detection/checks.ex+++ b/lib/plausible/installation_support/detection/checks.ex@@ -43,4 +43,26 @@ defmodule Plausible.InstallationSupport.Detection.Checks dostate.url)end++ @unthrottled_checks 3+ @first_slowdown_ms 1000+ def run_with_rate_limit(url, data_domain, opts \\ []) do+ case Plausible.RateLimit.check_rate(+ "site_detection:#{data_domain}",+ :timer.minutes(60),+ 10+ ) do+ {:allow, count} when count <= @unthrottled_checks ->+ {:ok, run(url, data_domain, opts)}++ {:allow, count} when count > @unthrottled_checks ->+ # slowdown steps 1x, 4x, 9x, 16x, ...+ slowdown_ms = @first_slowdown_ms * (count - @unthrottled_checks) ** 2+ :timer.sleep(slowdown_ms)+ {:ok, run(url, data_domain, opts)}++ {:deny, limit} ->+ {:error, {:rate_limit_exceeded, limit}}+ end+ endenddiff --git a/lib/plausible_web/live/change_domain_v2.ex b/lib/plausible_web/live/change_domain_v2.exindex aceaa5956c..fbca32a9e9 100644--- a/lib/plausible_web/live/change_domain_v2.ex+++ b/lib/plausible_web/live/change_domain_v2.ex@@ -173,24 +173,22 @@ defmodule PlausibleWeb.Live.ChangeDomainV2 doenddefp run_detection(domain) do- detection_result =- Detection.Checks.run(nil, domain,- detect_v1?: true,- report_to: nil,- async?: false,- slowdown: 0- )- |> Detection.Checks.interpret_diagnostics()-- case detection_result do- %Result{- ok?: true,- data: data- } ->- {:ok, %{detection_result: data}}-+ with {:ok, detection_result} <-+ Detection.Checks.run_with_rate_limit(nil, domain,+ detect_v1?: true,+ report_to: nil,+ async?: false,+ slowdown: 0+ ),+ %Result{ok?: true, data: data} <-+ Detection.Checks.interpret_diagnostics(detection_result) do+ {:ok, %{detection_result: data}}+ else%Result{ok?: false, errors: errors} ->{:error, List.first(errors, :unknown_reason)}++ {:error, {:rate_limit_exceeded, _}} ->+ {:error, :rate_limit_exceeded}endendelsediff --git a/lib/plausible_web/live/installationv2.ex b/lib/plausible_web/live/installationv2.exindex fc281eb3df..b27d420174 100644--- a/lib/plausible_web/live/installationv2.ex+++ b/lib/plausible_web/live/installationv2.ex@@ -206,24 +206,18 @@ defmodule PlausibleWeb.Live.InstallationV2 doon_ee dodefp detect_recommended_installation_type(flow, site) do- detection_result =- Detection.Checks.run(nil, site.domain,- detect_v1?: flow == Flows.review(),- report_to: nil,- slowdown: 0,- async?: false- )- |> Detection.Checks.interpret_diagnostics()-- case detection_result do- %Result{- ok?: true,- data: %{suggested_technology: suggested_technology, v1_detected: v1_detected}- } ->- {suggested_technology, v1_detected}-- _ ->- {"manual", false}+ with {:ok, detection_result} <-+ Detection.Checks.run_with_rate_limit(nil, site.domain,+ detect_v1?: flow == Flows.review(),+ report_to: nil,+ slowdown: 0,+ async?: false+ ),+ %Result{ok?: true, data: data} <-+ Detection.Checks.interpret_diagnostics(detection_result) do+ {data.suggested_technology, data.v1_detected}+ else+ _ -> {"manual", false}endendelsediff --git a/lib/plausible_web/live/verification.ex b/lib/plausible_web/live/verification.exindex dbb106f094..7949a3487d 100644--- a/lib/plausible_web/live/verification.ex+++ b/lib/plausible_web/live/verification.ex@@ -140,7 +140,7 @@ defmodule PlausibleWeb.Live.Verification do{:noreply, socket}elsecase Plausible.RateLimit.check_rate(- "site_verification_#{socket.assigns.domain}",+ "site_verification:#{socket.assigns.domain}",:timer.minutes(60),3) dodiff --git a/test/plausible_web/live/change_domain_v2_test.exs b/test/plausible_web/live/change_domain_v2_test.exsindex e2855f340a..d394beaf5f 100644--- a/test/plausible_web/live/change_domain_v2_test.exs+++ b/test/plausible_web/live/change_domain_v2_test.exs@@ -4,7 +4,6 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test doimport Phoenix.LiveViewTestimport Plausible.TestUtils- import ExUnit.CaptureLogimport Plausible.Test.Support.HTMLon_ee do@@ -88,7 +87,7 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test doendoriginal_domain = site.domain- new_domain = "new-example.com"+ new_domain = "new.#{site.domain}"{:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")lv@@ -111,14 +110,14 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test doendoriginal_domain = site.domain- new_domain = "new-example.com"+ new_domain = "new.#{site.domain}"{:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")lv|> element("form")|> render_submit(%{site: %{domain: new_domain}})- assert_patch(lv, "/#{new_domain}/change-domain-v2/success")+ assert_patch(lv, "/#{URI.encode_www_form(new_domain)}/change-domain-v2/success")html = render_async(lv, 500)assert html =~ "Domain Changed Successfully"@@ -164,14 +163,14 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test do"wordpressPlugin" => true})- new_domain = "new-example.com"+ new_domain = "new.#{site.domain}"{:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")lv|> element("form")|> render_submit(%{site: %{domain: new_domain}})- assert_patch(lv, "/#{new_domain}/change-domain-v2/success")+ assert_patch(lv, "/#{URI.encode_www_form(new_domain)}/change-domain-v2/success")html = render_async(lv, 500)assert html =~ "<i>must</i>"@@ -197,14 +196,14 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test do"wordpressPlugin" => false})- new_domain = "new-example.com"+ new_domain = "new.#{site.domain}"{:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")lv|> element("form")|> render_submit(%{site: %{domain: new_domain}})- assert_patch(lv, "/#{new_domain}/change-domain-v2/success")+ assert_patch(lv, "/#{URI.encode_www_form(new_domain)}/change-domain-v2/success")html = render_async(lv, 500)assert html =~ "<i>must</i>"@@ -228,14 +227,14 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test do"wordpressPlugin" => false})- new_domain = "new-example.com"+ new_domain = "new.#{site.domain}"{:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")lv|> element("form")|> render_submit(%{site: %{domain: new_domain}})- assert_patch(lv, "/#{new_domain}/change-domain-v2/success")+ assert_patch(lv, "/#{URI.encode_www_form(new_domain)}/change-domain-v2/success")html = render_async(lv, 500)refute html =~ "Additional Steps Required"@@ -258,14 +257,14 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test do"wordpressPlugin" => false})- new_domain = "new-example.com"+ new_domain = "new.#{site.domain}"{:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")lv|> element("form")|> render_submit(%{site: %{domain: new_domain}})- assert_patch(lv, "/#{new_domain}/change-domain-v2/success")+ assert_patch(lv, "/#{URI.encode_www_form(new_domain)}/change-domain-v2/success")html = render_async(lv, 500)assert html =~ "<i>must</i>"@@ -279,26 +278,63 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test do)end- @tag :ee_only+ @tag ee_only: true, capture_log: true+ test "ratelimit is respected: browserless request isn't made and the notice is generic", %{+ conn: conn,+ site: site+ } do+ new_domain = "new.#{site.domain}"++ # exceed the rate limit for site detection+ Plausible.RateLimit.check_rate(+ Plausible.RateLimit,+ "site_detection:#{new_domain}",+ :timer.minutes(60),+ 1,+ 100+ )++ # stub won't be used, if it were used, the output would be different+ stub_detection_result(%{+ "v1Detected" => false,+ "gtmLikely" => false,+ "wordpressLikely" => false,+ "wordpressPlugin" => false+ })++ {:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")++ lv+ |> element("form")+ |> render_submit(%{site: %{domain: new_domain}})++ assert_patch(lv, "/#{URI.encode_www_form(new_domain)}/change-domain-v2/success")++ html = render_async(lv, 500)+ assert html =~ "Additional Steps Required"+ assert html =~ "<i>must</i>"+ assert html =~ "also update the site"+ assert html =~ "Plausible Installation"+ end++ @tag ee_only: true, capture_log: truetest "success page handles detection error gracefully", %{conn: conn, site: site} dostub_detection_error()- capture_log(fn ->- new_domain = "new-example.com"- {:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")+ new_domain = "new.#{site.domain}"+ {:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")- lv- |> element("form")- |> render_submit(%{site: %{domain: new_domain}})+ lv+ |> element("form")+ |> render_submit(%{site: %{domain: new_domain}})- assert_patch(lv, "/#{new_domain}/change-domain-v2/success")+ assert_patch(lv, "/#{URI.encode_www_form(new_domain)}/change-domain-v2/success")- html = render_async(lv, 500)- assert html =~ "Additional Steps Required"- assert html =~ "<i>must</i>"- assert html =~ "also update the site"- assert html =~ "Plausible Installation"- end)+ html = render_async(lv, 500)+ assert html =~ "Additional Steps Required"+ assert html =~ "<i>must</i>"+ assert html =~ "also update the site"+ assert html =~ "Plausible Installation"end@tag :ce_build_only@@ -306,14 +342,14 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test doconn: conn,site: site} do- new_domain = "new-example.com"+ new_domain = "new.#{site.domain}"{:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain-v2")lv|> element("form")|> render_submit(%{site: %{domain: new_domain}})- assert_patch(lv, "/#{new_domain}/change-domain-v2/success")+ assert_patch(lv, "/#{URI.encode_www_form(new_domain)}/change-domain-v2/success")html = render_async(lv, 500)notice = text_of_element(html, "div[data-testid='ce-generic-notice']")diff --git a/test/plausible_web/live/installationv2_test.exs b/test/plausible_web/live/installationv2_test.exsindex dfa1410923..cc765a72b2 100644--- a/test/plausible_web/live/installationv2_test.exs+++ b/test/plausible_web/live/installationv2_test.exs@@ -372,6 +372,31 @@ defmodule PlausibleWeb.Live.InstallationV2Test doassert text(html) =~ "We've detected your website is using WordPress"end+ @tag :ee_only+ test "if ratelimit for detection is exceeded, does not make detection request and falls back to recommending manual installation",+ %{conn: conn, site: site} do+ stub_dns_lookup_a_records(site.domain)++ # exceed the rate limit for site detection+ Plausible.RateLimit.check_rate(+ Plausible.RateLimit,+ "site_detection:#{site.domain}",+ :timer.minutes(60),+ 1,+ 100+ )++ # this won't be used: if it were used, the output would be different+ stub_detection_wordpress()++ {lv, _} = get_lv(conn, site)++ html = render_async(lv, 500)++ refute text(html) =~ "We've detected your website is using WordPress"+ assert text(html) =~ "Verify Script installation"+ end+@tag :ee_onlytest "detected GTM installation shows special message", %{conn: conn, site: site} dostub_dns_lookup_a_records(site.domain)