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
tracker_script_configuration: drop writes and reads to `installation_meta` (step 4) (#5409)
Karl-Aksel Puulmann8bbb4408daf6
diff --git a/lib/plausible/site/tracker_script_configuration.ex b/lib/plausible/site/tracker_script_configuration.exindex dca9a65f68..6f462829a6 100644--- a/lib/plausible/site/tracker_script_configuration.ex+++ b/lib/plausible/site/tracker_script_configuration.ex@@ -4,6 +4,7 @@ defmodule Plausible.Site.TrackerScriptConfiguration do"""use Ecto.Schemaimport Ecto.Changeset+ import Ecto.Query@type t() :: %__MODULE__{}@@ -53,6 +54,20 @@ defmodule Plausible.Site.TrackerScriptConfiguration do)end+ def get_or_create!(site_id) do+ existing_configuration =+ Plausible.Repo.one(+ from(c in Plausible.Site.TrackerScriptConfiguration, where: c.site_id == ^site_id)+ )++ if existing_configuration do+ existing_configuration+ else+ {:ok, new_configuration} = upsert(%{site_id: site_id})+ new_configuration+ end+ end+defp fields_to_update(configuration_map) dofields = __MODULE__.__schema__(:fields)diff --git a/lib/plausible/sites.ex b/lib/plausible/sites.exindex 9565bbc313..05a75210b2 100644--- a/lib/plausible/sites.ex+++ b/lib/plausible/sites.ex@@ -345,13 +345,6 @@ defmodule Plausible.Sites dobase <> domain <> "?auth=" <> link.slugend- def update_installation_meta!(site, meta) do- site- |> Ecto.Changeset.change()- |> Ecto.Changeset.put_change(:installation_meta, meta)- |> Repo.update!()- end-def update_legacy_time_on_page_cutoff!(site, cutoff) dosite|> Ecto.Changeset.change()diff --git a/lib/plausible_web/live/installation.ex b/lib/plausible_web/live/installation.exindex ee94808807..73010908e1 100644--- a/lib/plausible_web/live/installation.ex+++ b/lib/plausible_web/live/installation.ex@@ -4,7 +4,7 @@ defmodule PlausibleWeb.Live.Installation do"""use PlausibleWeb, :live_viewalias Plausible.Verification.{Checks, State}- alias Plausible.Site.InstallationMeta+ alias Plausible.Site.TrackerScriptConfiguration@script_extension_params %{"outbound_links" => "outbound-links",@@ -50,7 +50,7 @@ defmodule PlausibleWeb.Live.Installation doflow = params["flow"]- tracker_script_configuration = InstallationMeta.to_tracker_script_configuration(site)+ tracker_script_configuration = TrackerScriptConfiguration.get_or_create!(site.id)installation_type = get_installation_type(flow, tracker_script_configuration, params)config =@@ -472,7 +472,13 @@ defmodule PlausibleWeb.Live.Installation do@domain_change PlausibleWeb.Flows.domain_change()defp get_installation_type(@domain_change, tracker_script_configuration, params) do- tracker_script_configuration.installation_type || get_installation_type(nil, nil, params)+ case tracker_script_configuration.installation_type do+ nil ->+ get_installation_type(nil, nil, params)++ installation_type ->+ Atom.to_string(installation_type)+ endenddefp get_installation_type(_type, _tracker_script_configuration, params) dodiff --git a/lib/plausible_web/plugs/tracker_plug.ex b/lib/plausible_web/plugs/tracker_plug.exindex 20a0aeb054..abde702779 100644--- a/lib/plausible_web/plugs/tracker_plug.ex+++ b/lib/plausible_web/plugs/tracker_plug.ex@@ -60,10 +60,13 @@ defmodule PlausibleWeb.TrackerPlug doenddefp request_tracker_script(tag, conn) do- site = Plausible.Repo.one(from s in Plausible.Site, where: s.installation_meta["id"] == ^tag)+ tracker_script_configuration =+ Plausible.Repo.one(+ from s in Plausible.Site.TrackerScriptConfiguration, where: s.id == ^tag, preload: [:site]+ )- if site do- script_tag = PlausibleWeb.Tracker.plausible_main_script_tag(site)+ if tracker_script_configuration do+ script_tag = PlausibleWeb.Tracker.plausible_main_script_tag(tracker_script_configuration)conn|> put_resp_header("content-type", "application/javascript")@@ -71,6 +74,9 @@ defmodule PlausibleWeb.TrackerPlug do|> put_resp_header("cross-origin-resource-policy", "cross-origin")|> put_resp_header("access-control-allow-origin", "*")|> put_resp_header("cache-control", "public, max-age=60, no-transform")+ # CDN-Tag is used by BunnyCDN to tag cached resources. This allows us to purge+ # specific tracker scripts from the CDN cache.+ |> put_resp_header("cdn-tag", "tracker_script::#{tracker_script_configuration.id}")|> send_resp(200, script_tag)|> halt()elsediff --git a/lib/plausible_web/tracker.ex b/lib/plausible_web/tracker.exindex e6a80c9578..0d788ba7e7 100644--- a/lib/plausible_web/tracker.ex+++ b/lib/plausible_web/tracker.ex@@ -13,9 +13,9 @@ defmodule PlausibleWeb.Tracker do@plausible_main_script File.read!(path)@external_resource "priv/tracker/js/plausible-main.js"- def plausible_main_script_tag(site) do+ def plausible_main_script_tag(tracker_script_configuration) doconfig_js_content =- site+ tracker_script_configuration|> plausible_main_config()|> Enum.flat_map(fn{key, value} when is_binary(value) -> ["#{key}:#{JSON.encode!(value)}"]@@ -31,17 +31,15 @@ defmodule PlausibleWeb.Tracker do|> String.replace("\"<%= @config_js %>\"", "{#{config_js_content}}")end- def plausible_main_config(site) do- script_config = site.installation_meta.script_config-+ def plausible_main_config(tracker_script_configuration) do%{- domain: site.domain,+ domain: tracker_script_configuration.site.domain,endpoint: "#{PlausibleWeb.Endpoint.url()}/api/event",- hash: Map.get(script_config, "hash", false),- outboundLinks: Map.get(script_config, "outbound-links", false),- fileDownloads: Map.get(script_config, "file-downloads", false),- taggedEvents: Map.get(script_config, "tagged-events", false),- revenue: Map.get(script_config, "revenue", false),+ hash: tracker_script_configuration.hash_based_routing,+ outboundLinks: tracker_script_configuration.outbound_links,+ fileDownloads: tracker_script_configuration.file_downloads,+ taggedEvents: tracker_script_configuration.tagged_events,+ revenue: tracker_script_configuration.revenue_tracking,# Options not directly exposed via onboardinglocal: false,manual: false@@ -49,18 +47,15 @@ defmodule PlausibleWeb.Tracker doenddef update_script_configuration(site, config_update) do- installation_meta_update = to_installation_meta(config_update)+ {:ok, updated_config} = TrackerScriptConfiguration.upsert(config_update)- Repo.transaction(fn ->- Plausible.Sites.update_installation_meta!(site, installation_meta_update)- {:ok, _} = TrackerScriptConfiguration.upsert(config_update)+ sync_goals(site, config_update)- update_goals(site, config_update)- end)+ updated_configend# Sync plausible goals with the updated script config- defp update_goals(site, config_update) do+ defp sync_goals(site, config_update) doconfig_update|> Enum.map(fn {key, value} -> {to_atom(key), value} end)|> Enum.each(fn@@ -74,25 +69,6 @@ defmodule PlausibleWeb.Tracker doend)end- defp to_installation_meta(config_update) do- %{- installation_type: remap_installation_type(config_update["installation_type"]),- script_config: %{- "404" => Map.get(config_update, "track_404_pages", false),- "hash" => Map.get(config_update, "hash_based_routing", false),- "outbound-links" => Map.get(config_update, "outbound_links", false),- "file-downloads" => Map.get(config_update, "file_downloads", false),- "revenue" => Map.get(config_update, "revenue_tracking", false),- "tagged-events" => Map.get(config_update, "tagged_events", false),- "pageview-props" => Map.get(config_update, "pageview_props", false)- }- }- end-- defp remap_installation_type("wordpress"), do: "WordPress"- defp remap_installation_type("gtm"), do: "GTM"- defp remap_installation_type(value), do: value-defp to_atom(str) when is_binary(str), do: String.to_existing_atom(str)defp to_atom(atom) when is_atom(atom), do: atomenddiff --git a/test/plausible_web/live/installation_test.exs b/test/plausible_web/live/installation_test.exsindex dc3729f193..b985f24427 100644--- a/test/plausible_web/live/installation_test.exs+++ b/test/plausible_web/live/installation_test.exs@@ -30,6 +30,12 @@ defmodule PlausibleWeb.Live.InstallationTest doendtest "static verification screen renders for flow=domain_change", %{conn: conn, site: site} do+ {:ok, _} =+ Plausible.Site.TrackerScriptConfiguration.upsert(%{+ site_id: site.id,+ installation_type: :manual+ })+resp =conn|> get("/#{site.domain}/installation?flow=#{PlausibleWeb.Flows.domain_change()}")@@ -48,7 +54,11 @@ defmodule PlausibleWeb.Live.InstallationTest dotest "static verification screen renders for flow=domain_change using original installation type",%{conn: conn, site: site} do- site = Plausible.Sites.update_installation_meta!(site, %{installation_type: "WordPress"})+ {:ok, _} =+ Plausible.Site.TrackerScriptConfiguration.upsert(%{+ site_id: site.id,+ installation_type: :wordpress+ })resp =conn@@ -58,7 +68,7 @@ defmodule PlausibleWeb.Live.InstallationTest doassert resp =~ "Your domain has been changed"assert resp =~ "I understand, I'll update my website"assert resp =~ "WordPress plugin"- refute resp =~ "Manuial installation"+ refute resp =~ "Manual installation"refute resp =~ "Review your existing installation."assert resp =~diff --git a/test/plausible_web/plugs/tracker_plug_test.exs b/test/plausible_web/plugs/tracker_plug_test.exsindex fdfa47d26a..fa24503ea4 100644--- a/test/plausible_web/plugs/tracker_plug_test.exs+++ b/test/plausible_web/plugs/tracker_plug_test.exs@@ -17,23 +17,27 @@ defmodule PlausibleWeb.TrackerPlugTest douse Plug.Testuse Plausible.Teams.Test+ alias Plausible.Site.TrackerScriptConfiguration+describe "plausible-main.js" do@example_config %{- "404" => true,- "hash" => true,- "file-downloads" => false,- "outbound-links" => false,- "pageview-props" => false,- "tagged-events" => true,- "revenue" => false+ installation_type: :manual,+ track_404_pages: true,+ hash_based_routing: true,+ file_downloads: false,+ outbound_links: false,+ pageview_props: false,+ tagged_events: true,+ revenue_tracking: false}test "returns the script for an existing site", %{conn: conn} do- site =- new_site()- |> Plausible.Sites.update_installation_meta!(%{script_config: @example_config})+ site = new_site()++ {:ok, tracker_script_configuration} =+ TrackerScriptConfiguration.upsert(Map.put(@example_config, :site_id, site.id))- response = get(conn, "/js/s-#{site.installation_meta.id}.js") |> response(200)+ response = get(conn, "/js/s-#{tracker_script_configuration.id}.js") |> response(200)assert String.contains?(response, "!function(){var")assert String.contains?(response, "domain:\"#{site.domain}\"")@@ -44,11 +48,12 @@ defmodule PlausibleWeb.TrackerPlugTest do# window.plausible is a substring checked for by the wordpress plugin to avoid 'optimization' by other wordpress pluginstest "script contains window.plausible", %{conn: conn} do- site =- new_site()- |> Plausible.Sites.update_installation_meta!(%{script_config: @example_config})+ site = new_site()++ {:ok, tracker_script_configuration} =+ TrackerScriptConfiguration.upsert(Map.put(@example_config, :site_id, site.id))- response = get(conn, "/js/s-#{site.installation_meta.id}.js") |> response(200)+ response = get(conn, "/js/s-#{tracker_script_configuration.id}.js") |> response(200)assert String.contains?(response, "window.plausible")enddiff --git a/test/plausible_web/tracker_test.exs b/test/plausible_web/tracker_test.exsindex f135129c48..49d6b50daa 100644--- a/test/plausible_web/tracker_test.exs+++ b/test/plausible_web/tracker_test.exs@@ -2,23 +2,25 @@ defmodule PlausibleWeb.TrackerTest douse Plausible.DataCase, async: trueuse Plausible.Teams.Test+ alias Plausible.Site.TrackerScriptConfiguration+describe "plausible-main.js" do@example_config %{- "404" => true,- "hash" => true,- "file-downloads" => false,- "outbound-links" => false,- "pageview-props" => false,- "tagged-events" => true,- "revenue" => false+ installation_type: :manual,+ track_404_pages: true,+ hash_based_routing: true,+ file_downloads: false,+ outbound_links: false,+ pageview_props: false,+ tagged_events: true,+ revenue_tracking: false}test "can calculate config" do- site =- new_site()- |> Plausible.Sites.update_installation_meta!(%{script_config: @example_config})+ site = new_site()+ tracker_script_configuration = create_config(site)- assert PlausibleWeb.Tracker.plausible_main_config(site) == %{+ assert PlausibleWeb.Tracker.plausible_main_config(tracker_script_configuration) == %{domain: site.domain,endpoint: "#{PlausibleWeb.Endpoint.url()}/api/event",hash: true,@@ -32,25 +34,29 @@ defmodule PlausibleWeb.TrackerTest doendtest "can turn config into a script tag" do- site =- new_site()- |> Plausible.Sites.update_installation_meta!(%{script_config: @example_config})+ site = new_site()+ tracker_script_configuration = create_config(site)- script_tag = PlausibleWeb.Tracker.plausible_main_script_tag(site)+ script_tag = PlausibleWeb.Tracker.plausible_main_script_tag(tracker_script_configuration)assert script_tag =~~s(={endpoint:"#{PlausibleWeb.Endpoint.url()}/api/event",domain:"#{site.domain}",taggedEvents:!0,hash:!0})endtest "script tag escapes problematic characters as expected" do- site =- new_site()- |> Plausible.Sites.update_installation_meta!(%{script_config: @example_config})- |> Map.merge(%{domain: "naughty domain &<> \"\'\nfoo "})-- script_tag = PlausibleWeb.Tracker.plausible_main_script_tag(site)+ site = new_site(domain: "naughty domain &<> \"\'\nfoo ")+ tracker_script_configuration = create_config(site)+ script_tag = PlausibleWeb.Tracker.plausible_main_script_tag(tracker_script_configuration)assert script_tag =~ ~s(domain:"naughty domain &<> \\"'\\nfoo ")end++ def create_config(site) do+ {:ok, _} = TrackerScriptConfiguration.upsert(Map.put(@example_config, :site_id, site.id))++ Plausible.Repo.one(+ from(c in TrackerScriptConfiguration, where: c.site_id == ^site.id, preload: [:site])+ )+ endendend