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
ScriptV2: Domain change refinement (#5657)
Karl-Aksel Puulmannbcf8b422e1c9
diff --git a/lib/plausible/installation_support/checks/detection.ex b/lib/plausible/installation_support/checks/detection.exindex 44e2a55a7f..d52cf73a22 100644--- a/lib/plausible/installation_support/checks/detection.ex+++ b/lib/plausible/installation_support/checks/detection.ex@@ -139,6 +139,7 @@ defmodule Plausible.InstallationSupport.Checks.Detection dodo: [v1_detected: data["v1Detected"],gtm_likely: data["gtmLikely"],+ npm: data["npm"],wordpress_likely: data["wordpressLikely"],wordpress_plugin: data["wordpressPlugin"],service_error: nildiff --git a/lib/plausible/installation_support/detection/diagnostics.ex b/lib/plausible/installation_support/detection/diagnostics.exindex 581a2ad7ef..412ed6e732 100644--- a/lib/plausible/installation_support/detection/diagnostics.ex+++ b/lib/plausible/installation_support/detection/diagnostics.ex@@ -9,6 +9,7 @@ defmodule Plausible.InstallationSupport.Detection.Diagnostics dogtm_likely: nil,wordpress_likely: nil,wordpress_plugin: nil,+ npm: nil,service_error: nil@type t :: %__MODULE__{}@@ -39,6 +40,16 @@ defmodule Plausible.InstallationSupport.Detection.Diagnostics do)end+ def interpret(+ %__MODULE__{+ npm: true,+ service_error: nil+ } = diagnostics,+ _url+ ) do+ get_result("npm", diagnostics)+ end+def interpret(%__MODULE__{service_error: nil@@ -78,6 +89,7 @@ defmodule Plausible.InstallationSupport.Detection.Diagnostics dodata: %{v1_detected: diagnostics.v1_detected,wordpress_plugin: diagnostics.wordpress_plugin,+ npm: diagnostics.npm,suggested_technology: suggested_technology}}diff --git a/lib/plausible_web/live/change_domain_v2.ex b/lib/plausible_web/live/change_domain_v2.exindex a7152ea9e9..ea1e1370cf 100644--- a/lib/plausible_web/live/change_domain_v2.ex+++ b/lib/plausible_web/live/change_domain_v2.ex@@ -86,20 +86,16 @@ defmodule PlausibleWeb.Live.ChangeDomainV2 do</:subtitle><:footer>- <.focus_list>- <:item>- <.styled_link href={Routes.site_path(@socket, :settings_general, @site.domain)}>- Go to Site Settings- </.styled_link>- </:item>- </.focus_list>+ <.styled_link href={Routes.site_path(@socket, :settings_general, @site.domain)}>+ ← Back to Site Settings+ </.styled_link></:footer><.async_result :let={detection_result} assign={@detection_result}><:loading><div class="flex items-center"><.spinner class="w-4 h-4 mr-2" />- <span class="text-sm text-gray-600">Checking your new domain...</span>+ <span class="text-sm text-gray-600 dark:text-gray-400">Checking your new domain...</span></div></:loading>@@ -107,17 +103,21 @@ defmodule PlausibleWeb.Live.ChangeDomainV2 do<.generic_notice /></:failed>- <.wordpress_plugin_notice :if={- detection_result && detection_result.v1_detected && detection_result.wordpress_plugin- } />- <.generic_notice :if={- detection_result && detection_result.v1_detected && !detection_result.wordpress_plugin- } />+ <.success_notice :if={detection_result} detection_result={detection_result} /></.async_result></.focus_box>"""end+ defp success_notice(assigns) do+ case assigns.detection_result do+ %{v1_detected: true, wordpress_plugin: true} -> wordpress_plugin_notice(assigns)+ %{v1_detected: true, wordpress_plugin: false} -> generic_notice(assigns)+ %{v1_detected: false, npm: true} -> generic_notice(assigns)+ _ -> ~H""+ end+ end+defp wordpress_plugin_notice(assigns) do~H"""<.notice class="mt-4" title="Additional Steps Required">@@ -149,6 +149,8 @@ defmodule PlausibleWeb.Live.ChangeDomainV2 doenddef handle_info({:domain_changed, updated_site}, socket) do+ PlausibleWeb.Tracker.purge_tracker_script_cache!(updated_site)+{:noreply,socket|> assign(site: updated_site)@@ -168,18 +170,9 @@ defmodule PlausibleWeb.Live.ChangeDomainV2 docase detection_result do%Result{ok?: true,- data: %{- v1_detected: v1_detected,- wordpress_plugin: wordpress_plugin- }+ data: data} ->- {:ok,- %{- detection_result: %{- v1_detected: v1_detected,- wordpress_plugin: wordpress_plugin- }- }}+ {:ok, %{detection_result: data}}%Result{ok?: false, errors: errors} ->{:error, List.first(errors, :unknown_reason)}diff --git a/lib/plausible_web/plugins/api/schemas/tracker_script_configuration.ex b/lib/plausible_web/plugins/api/schemas/tracker_script_configuration.exindex 4087621f14..db10798e06 100644--- a/lib/plausible_web/plugins/api/schemas/tracker_script_configuration.ex+++ b/lib/plausible_web/plugins/api/schemas/tracker_script_configuration.ex@@ -24,7 +24,7 @@ defmodule PlausibleWeb.Plugins.API.Schemas.TrackerScriptConfiguration doinstallation_type: %Schema{type: :string,description: "Tracker Script Installation Type",- enum: ["manual", "wordpress", "gtm"]+ enum: ["manual", "wordpress", "gtm", "npm"]},hash_based_routing: %Schema{type: :boolean, description: "Hash Based Routing"},outbound_links: %Schema{type: :boolean, description: "Track Outbound Links"},diff --git a/lib/plausible_web/plugins/api/schemas/tracker_script_configuration/update_request.ex b/lib/plausible_web/plugins/api/schemas/tracker_script_configuration/update_request.exindex 2a3178d66d..cc5b464587 100644--- a/lib/plausible_web/plugins/api/schemas/tracker_script_configuration/update_request.ex+++ b/lib/plausible_web/plugins/api/schemas/tracker_script_configuration/update_request.ex@@ -17,7 +17,7 @@ defmodule PlausibleWeb.Plugins.API.Schemas.TrackerScriptConfiguration.UpdateRequinstallation_type: %Schema{type: :string,description: "Tracker Script Installation Type",- enum: ["manual", "wordpress", "gtm"]+ enum: ["manual", "wordpress", "gtm", "npm"]},hash_based_routing: %Schema{type: :boolean, description: "Hash Based Routing"},outbound_links: %Schema{type: :boolean, description: "Track Outbound Links"},diff --git a/lib/plausible_web/tracker.ex b/lib/plausible_web/tracker.exindex 8a98b42d3a..6e258e4796 100644--- a/lib/plausible_web/tracker.ex+++ b/lib/plausible_web/tracker.ex@@ -83,6 +83,11 @@ defmodule PlausibleWeb.Tracker doendon_ee do+ def purge_tracker_script_cache!(site) do+ tracker_script_configuration = get_or_create_tracker_script_configuration!(site)+ purge_cache!(tracker_script_configuration.id)+ end+defp should_purge_cache?(changeset) doMap.keys(changeset.changes) != [:installation_type]end@@ -96,6 +101,8 @@ defmodule PlausibleWeb.Tracker do)|> Oban.insert!()end+ else+ def purge_tracker_script_cache!(_site), do: nilenddef update_script_configuration!(site, config_update, changeset_type) dodiff --git a/test/plausible_web/live/change_domain_v2_test.exs b/test/plausible_web/live/change_domain_v2_test.exsindex 783508e87c..4606fe9e6b 100644--- a/test/plausible_web/live/change_domain_v2_test.exs+++ b/test/plausible_web/live/change_domain_v2_test.exs@@ -223,6 +223,31 @@ defmodule PlausibleWeb.Live.ChangeDomainV2Test dorefute html =~ "also update the site"end+ test "success page shows generic npm notice when detected", %{conn: conn, site: site} do+ stub_detection_result(%{+ "v1Detected" => false,+ "gtmLikely" => false,+ "npm" => true,+ "wordpressLikely" => false,+ "wordpressPlugin" => false+ })++ new_domain = "new-example.com"+ {: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")++ html = render_async(lv, 500)+ assert html =~ "<i>must</i>"+ assert html =~ "also update the site"+ assert html =~ "Plausible Installation"+ assert html =~ "within 72 hours"+ end+test "success page handles detection error gracefully", %{conn: conn, site: site} dostub_detection_error()diff --git a/test/plausible_web/live/installationv2_test.exs b/test/plausible_web/live/installationv2_test.exsindex 5f46405714..eeb0c1dcb8 100644--- a/test/plausible_web/live/installationv2_test.exs+++ b/test/plausible_web/live/installationv2_test.exs@@ -301,6 +301,21 @@ defmodule PlausibleWeb.Live.InstallationV2Test doassert text(html) =~ "We've detected your website is using Google Tag Manager"end+ test "detected NPM installation shows npm tab", %{conn: conn, site: site} do+ stub_detection_result(%{+ "v1Detected" => false,+ "gtmLikely" => false,+ "npm" => true,+ "wordpressLikely" => false,+ "wordpressPlugin" => false+ })++ {lv, _} = get_lv(conn, site)++ html = render_async(lv, 500)+ assert html =~ "Verify NPM installation"+ end+test "shows v1 detection warning for manual installation", %{conn: conn, site: site} dostub_dns_lookup_a_records(site.domain)stub_detection_manual_with_v1()@@ -468,6 +483,7 @@ defmodule PlausibleWeb.Live.InstallationV2Test dostub_detection_result(%{"v1Detected" => false,"gtmLikely" => false,+ "npm" => false,"wordpressLikely" => false,"wordpressPlugin" => false})@@ -477,6 +493,7 @@ defmodule PlausibleWeb.Live.InstallationV2Test dostub_detection_result(%{"v1Detected" => false,"gtmLikely" => false,+ "npm" => false,"wordpressLikely" => true,"wordpressPlugin" => false})@@ -486,6 +503,7 @@ defmodule PlausibleWeb.Live.InstallationV2Test dostub_detection_result(%{"v1Detected" => false,"gtmLikely" => true,+ "npm" => false,"wordpressLikely" => false,"wordpressPlugin" => false})@@ -495,6 +513,7 @@ defmodule PlausibleWeb.Live.InstallationV2Test dostub_detection_result(%{"v1Detected" => true,"gtmLikely" => false,+ "npm" => false,"wordpressLikely" => false,"wordpressPlugin" => false})@@ -504,6 +523,7 @@ defmodule PlausibleWeb.Live.InstallationV2Test dostub_detection_result(%{"v1Detected" => true,"gtmLikely" => false,+ "npm" => false,"wordpressLikely" => true,"wordpressPlugin" => false})diff --git a/tracker/installation_support/check-npm.js b/tracker/installation_support/check-npm.jsnew file mode 100644index 0000000000..b52ee9c42b--- /dev/null+++ b/tracker/installation_support/check-npm.js@@ -0,0 +1,7 @@+export function checkNPM(document) {+ if (typeof document === 'object') {+ return window.plausible?.s === 'npm'+ }++ return false+}diff --git a/tracker/installation_support/detector.js b/tracker/installation_support/detector.jsindex 19d1bafadd..570e1cc6e3 100644--- a/tracker/installation_support/detector.js+++ b/tracker/installation_support/detector.js@@ -1,6 +1,7 @@import { waitForPlausibleFunction } from "./plausible-function-check"import { checkWordPress } from "./check-wordpress"import { checkGTM } from "./check-gtm"+import { checkNPM } from "./check-npm"window.scanPageBeforePlausibleInstallation = async function({ detectV1, debug, timeoutMs }) {function log(message) {@@ -24,6 +25,9 @@ window.scanPageBeforePlausibleInstallation = async function({ detectV1, debug, tconst gtmLikely = checkGTM(document)log(`gtmLikely: ${gtmLikely}`)+ const npm = checkNPM(document)+ log(`npm: ${npm}`)+return {data: {completed: true,@@ -31,6 +35,7 @@ window.scanPageBeforePlausibleInstallation = async function({ detectV1, debug, twordpressPlugin: wordpressPlugin,wordpressLikely: wordpressLikely,gtmLikely: gtmLikely,+ npm: npm}}-}\ No newline at end of file+}diff --git a/tracker/test/installation_support/detector.spec.js b/tracker/test/installation_support/detector.spec.jsindex 0e79947876..eea637721c 100644--- a/tracker/test/installation_support/detector.spec.js+++ b/tracker/test/installation_support/detector.spec.js@@ -52,6 +52,21 @@ test.describe('detector.js (tech recognition)', () => {expect(result.data.wordpressPlugin).toBe(false)expect(result.data.wordpressLikely).toBe(false)expect(result.data.gtmLikely).toBe(false)+ expect(result.data.npm).toBe(false)+ })++ test('npm is reported correctly', async ({ page }, { testId }) => {+ const { url } = await initializePageDynamically(page, {+ testId,+ scriptConfig: `<script type="module">import {init} from "/tracker/js/npm_package/plausible.js"; init({domain: "abc.de"});</script>`+ })++ const result = await detect(page, {url: url, detectV1: false})++ expect(result.data.wordpressPlugin).toBe(false)+ expect(result.data.wordpressLikely).toBe(false)+ expect(result.data.gtmLikely).toBe(false)+ expect(result.data.npm).toBe(true)})})@@ -77,6 +92,7 @@ test.describe('detector.js (v1 detection)', () => {expect(result.data.wordpressPlugin).toBe(true)expect(result.data.wordpressLikely).toBe(true)expect(result.data.gtmLikely).toBe(true)+ expect(result.data.npm).toBe(false)})test('v1Detected is false when plausible function does not exist', async ({ page }, { testId }) => {@@ -91,6 +107,7 @@ test.describe('detector.js (v1 detection)', () => {expect(result.data.wordpressPlugin).toBe(false)expect(result.data.wordpressLikely).toBe(false)expect(result.data.gtmLikely).toBe(false)+ expect(result.data.npm).toBe(false)})test('v1Detected is false when v2 plausible installed', async ({ page }, { testId }) => {