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
More verification tweaks (#4177)
hq15fd4547382aa
diff --git a/lib/plausible/verification/checks/scan_body.ex b/lib/plausible/verification/checks/scan_body.exindex 69ea4d2231..3c1bf5ad54 100644--- a/lib/plausible/verification/checks/scan_body.ex+++ b/lib/plausible/verification/checks/scan_body.ex@@ -13,6 +13,7 @@ defmodule Plausible.Verification.Checks.ScanBody do|> scan_wp_plugin()|> scan_gtm()|> scan_wp()+ |> scan_cookie_banners()enddef perform(state), do: state@@ -62,4 +63,20 @@ defmodule Plausible.Verification.Checks.ScanBody dostateendend++ defp scan_cookie_banners(%{assigns: %{raw_body: body}} = state) do+ # We'll start with CookieBot. Not using the selectors yet, as seen at+ # https://github.com/cavi-au/Consent-O-Matic/blob/master/rules/cookiebot.json+ # because those don't seem to be appearing without JS evaluation.+ # If this ever becomes an issue, we'll have to move that check to headless.+ if String.contains?(body, "cookiebot") do+ put_diagnostics(state, cookie_banner_likely?: true)+ else+ state+ end+ end++ defp scan_cookie_banners(state) do+ state+ endenddiff --git a/lib/plausible/verification/checks/snippet.ex b/lib/plausible/verification/checks/snippet.exindex d4bc72dc1b..9375a91122 100644--- a/lib/plausible/verification/checks/snippet.ex+++ b/lib/plausible/verification/checks/snippet.ex@@ -20,6 +20,7 @@ defmodule Plausible.Verification.Checks.Snippet dosnippets_found_in_head: Enum.count(in_head),snippets_found_in_body: Enum.count(in_body),proxy_likely?: proxy_likely?(all),+ manual_script_extension?: manual_script_extension?(all),snippet_unknown_attributes?: unknown_attributes?(all),data_domain_mismatch?:data_domain_mismatch?(all, state.data_domain, state.assigns[:final_domain])@@ -28,6 +29,12 @@ defmodule Plausible.Verification.Checks.Snippet dodef perform(state), do: state+ defp manual_script_extension?(nodes) do+ nodes+ |> Floki.attribute("src")+ |> Enum.any?(&String.contains?(&1, "manual."))+ end+defp proxy_likely?(nodes) donodes|> Floki.attribute("src")diff --git a/lib/plausible/verification/diagnostics.ex b/lib/plausible/verification/diagnostics.exindex d1c3c1aef4..131c69c696 100644--- a/lib/plausible/verification/diagnostics.ex+++ b/lib/plausible/verification/diagnostics.ex@@ -15,9 +15,11 @@ defmodule Plausible.Verification.Diagnostics doservice_error: nil,body_fetched?: false,wordpress_likely?: false,+ cookie_banner_likely?: false,gtm_likely?: false,callback_status: 0,proxy_likely?: false,+ manual_script_extension?: false,data_domain_mismatch?: false,wordpress_plugin?: false@@ -48,6 +50,13 @@ defmodule Plausible.Verification.Diagnostics do%Result{ok?: true}end+ def interpret(+ %__MODULE__{plausible_installed?: false, gtm_likely?: true, cookie_banner_likely?: true},+ _url+ ) do+ error(@errors.gtm_cookie_banner)+ end+def interpret(%__MODULE__{plausible_installed?: false, gtm_likely?: true}, _url) doerror(@errors.gtm)end@@ -206,7 +215,11 @@ defmodule Plausible.Verification.Diagnostics doenddef interpret(- %__MODULE__{snippets_found_in_head: count_head, snippets_found_in_body: count_body},+ %__MODULE__{+ snippets_found_in_head: count_head,+ snippets_found_in_body: count_body,+ manual_script_extension?: false+ },_url)when count_head + count_body > 1 do@@ -308,6 +321,21 @@ defmodule Plausible.Verification.Diagnostics do%Result{ok?: true}end+ def interpret(+ %__MODULE__{+ plausible_installed?: true,+ snippets_found_in_head: count_head,+ snippets_found_in_body: count_body,+ callback_status: callback_status,+ service_error: nil,+ manual_script_extension?: true+ },+ _url+ )+ when count_head + count_body > 1 and callback_status in [200, 202] do+ %Result{ok?: true}+ end+def interpret(rating, url) doSentry.capture_message("Unhandled case for site verification: #{url}",extra: %{diff --git a/lib/plausible/verification/errors.ex b/lib/plausible/verification/errors.exindex ac5ce0cff2..ed4e091e8e 100644--- a/lib/plausible/verification/errors.ex+++ b/lib/plausible/verification/errors.ex@@ -10,6 +10,12 @@ defmodule Plausible.Verification.Errors do"As you're using Google Tag Manager, you'll need to use a GTM-specific Plausible snippet",url: "https://plausible.io/docs/google-tag-manager"},+ gtm_cookie_banner: %{+ message: "We couldn't verify your website",+ recommendation:+ "As you're using Google Tag Manager, you'll need to use a GTM-specific Plausible snippet. Please make sure no cookie consent banner is blocking our script.",+ url: "https://plausible.io/docs/google-tag-manager"+ },csp: %{message: "We encountered an issue with your site's CSP",recommendation:diff --git a/test/plausible/site/verification/checks/scan_body_test.exs b/test/plausible/site/verification/checks/scan_body_test.exsindex 169ab89251..d5646dd17b 100644--- a/test/plausible/site/verification/checks/scan_body_test.exs+++ b/test/plausible/site/verification/checks/scan_body_test.exs@@ -28,6 +28,18 @@ defmodule Plausible.Verification.Checks.ScanBodyTest doassert state.diagnostics.gtm_likely?refute state.diagnostics.wordpress_likely?+ refute state.diagnostics.cookie_banner_likely?+ end++ test "detects GTM and cookie banner" do+ state =+ %State{}+ |> State.assign(raw_body: "...googletagmanager.com/gtm.js...cookiebot...")+ |> @check.perform()++ assert state.diagnostics.gtm_likely?+ assert state.diagnostics.cookie_banner_likely?+ refute state.diagnostics.wordpress_likely?endfor signature <- ["wp-content", "wp-includes", "wp-json"] dodiff --git a/test/plausible/site/verification/checks/snippet_test.exs b/test/plausible/site/verification/checks/snippet_test.exsindex fdba46643f..af27832069 100644--- a/test/plausible/site/verification/checks/snippet_test.exs+++ b/test/plausible/site/verification/checks/snippet_test.exs@@ -27,6 +27,7 @@ defmodule Plausible.Verification.Checks.SnippetTest dorefute state.diagnostics.data_domain_mismatch?refute state.diagnostics.snippet_unknown_attributes?refute state.diagnostics.proxy_likely?+ refute state.diagnostics.manual_script_extension?end@multi_domain """@@ -46,6 +47,7 @@ defmodule Plausible.Verification.Checks.SnippetTest dorefute state.diagnostics.data_domain_mismatch?refute state.diagnostics.snippet_unknown_attributes?refute state.diagnostics.proxy_likely?+ refute state.diagnostics.manual_script_extension?end@crazy """@@ -67,6 +69,7 @@ defmodule Plausible.Verification.Checks.SnippetTest doassert state.diagnostics.snippets_found_in_head == 2assert state.diagnostics.snippets_found_in_body == 3+ refute state.diagnostics.manual_script_extension?endtest "figures out data-domain mismatch" do@@ -80,6 +83,7 @@ defmodule Plausible.Verification.Checks.SnippetTest doassert state.diagnostics.data_domain_mismatch?refute state.diagnostics.snippet_unknown_attributes?refute state.diagnostics.proxy_likely?+ refute state.diagnostics.manual_script_extension?end@proxy_likely """@@ -99,6 +103,22 @@ defmodule Plausible.Verification.Checks.SnippetTest dorefute state.diagnostics.data_domain_mismatch?refute state.diagnostics.snippet_unknown_attributes?assert state.diagnostics.proxy_likely?+ refute state.diagnostics.manual_script_extension?+ end++ @manual_extension """+ <head>+ <script defer data-domain="example.com" event-author="Me" src="http://localhost:8000/js/script.manual.js"></script>+ </head>+ """++ test "figures out manual script extension" do+ state =+ @manual_extension+ |> new_state()+ |> @check.perform()++ assert state.diagnostics.manual_script_extension?end@unknown_attributes """diff --git a/test/plausible/site/verification/checks_test.exs b/test/plausible/site/verification/checks_test.exsindex 09e4649077..1ba949e8bf 100644--- a/test/plausible/site/verification/checks_test.exs+++ b/test/plausible/site/verification/checks_test.exs@@ -254,6 +254,27 @@ defmodule Plausible.Verification.ChecksTest do|> assert_error(@errors.multiple_snippets)end+ @many_snippets_ok """+ <html>+ <head>+ <script defer data-domain="example.com" src="https://plausible.io/js/script.js"></script>+ <script defer data-domain="example.com" src="https://plausible.io/js/script.manual.js"></script>+ </head>+ <body>+ Hello+ </body>+ </html>+ """++ test "skipping many snippets when manual found" do+ stub_fetch_body(200, @many_snippets_ok)+ stub_installation()++ run_checks()+ |> Checks.interpret_diagnostics()+ |> assert_ok()+ end+test "detecting snippet after busting cache" dostub_fetch_body(fn conn ->conn = fetch_query_params(conn)@@ -520,6 +541,33 @@ defmodule Plausible.Verification.ChecksTest do|> assert_error(@errors.gtm)end+ @gtm_body_with_cookiebot """+ <html>+ <head>+ <!-- Google Tag Manager -->+ <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':+ new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],+ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=+ 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);+ })(window,document,'script','dataLayer','XXXX');</script>+ <!-- End Google Tag Manager -->+ <script id="Cookiebot" src="https://consent.cookiebot.com/uc.js" data-cbid="some-uuid" data-blockingmode="auto" type="text/javascript"></script>+ </head>+ <body>+ Hello+ </body>+ </html>+ """++ test "detecting gtm with cookie consent" do+ stub_fetch_body(200, @gtm_body_with_cookiebot)+ stub_installation(200, plausible_installed(false))++ run_checks()+ |> Checks.interpret_diagnostics()+ |> assert_error(@errors.gtm_cookie_banner)+ end+test "non-html body" dostub_fetch_body(fn conn ->conn