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
Update tracker config in scriptv2 onboarding (#5443)
Uku Taht9a7cb6cc26a9
diff --git a/lib/plausible_web/live/installationv2.ex b/lib/plausible_web/live/installationv2.exindex 9773c76aab..5f9a4e917d 100644--- a/lib/plausible_web/live/installationv2.ex+++ b/lib/plausible_web/live/installationv2.ex@@ -18,10 +18,13 @@ defmodule PlausibleWeb.Live.InstallationV2 do:viewer])+ tracker_script_configuration =+ PlausibleWeb.Tracker.get_or_create_tracker_script_configuration!(site.id)+{:ok,assign(socket,site: site,- installation_form: to_form(site.installation_meta.script_config),+ tracker_script_configuration: tracker_script_configuration,flow: "provisioning",installation_type: params["type"] || "manual")}@@ -54,24 +57,30 @@ defmodule PlausibleWeb.Live.InstallationV2 do<.manual_instructions:if={@installation_type == "manual"}- installation_form={@installation_form}- installation_type={@installation_type}- flow={@flow}- site={@site}+ tracker_script_configuration={@tracker_script_configuration}/><.wordpress_instructions :if={@installation_type == "wordpress"} /><.gtm_instructions :if={@installation_type == "gtm"} /><.npm_instructions :if={@installation_type == "npm"} />++ <.button phx-click="submit" class="w-full mt-8">+ <%= if @flow == PlausibleWeb.Flows.domain_change() do %>+ I understand, I'll update my website+ <% else %>+ <%= if @flow == PlausibleWeb.Flows.review() do %>+ Verify your installation+ <% else %>+ Start collecting data+ <% end %>+ <% end %>+ </.button></.focus_box></div>"""end- attr :installation_form, :map, required: true- attr :installation_type, :string, required: true- attr :flow, :string, required: true- attr :site, :map, required: true+ attr :tracker_script_configuration, :map, required: truedefp manual_instructions(assigns) do~H"""@@ -89,12 +98,7 @@ defmodule PlausibleWeb.Live.InstallationV2 do</div><div class="mt-8">- <.snippet_form- installation_form={@installation_form}- installation_type={@installation_type}- flow={@flow}- site={@site}- />+ <.snippet_form tracker_script_configuration={@tracker_script_configuration} /></div>"""end@@ -176,14 +180,14 @@ defmodule PlausibleWeb.Live.InstallationV2 dodefp snippet_form(assigns) do~H"""- <form id="snippet-form">+ <form><div class="relative"><textareaid="snippet"- class="w-full border-1 border-gray-300 rounded-md p-4 text-sm text-gray-700 dark:border-gray-500 dark:bg-gray-900 dark:text-gray-300"- rows="5"+ class="w-full border-1 border-gray-300 rounded-md p-4 text-sm text-gray-700 dark:border-gray-500 dark:bg-gray-900 dark:text-gray-300 "+ rows="8"readonly- ><%= render_snippet(@site) %></textarea>+ ><%= render_snippet(@tracker_script_configuration) %></textarea><aonclick="var input = document.getElementById('snippet'); input.focus(); input.select(); document.execCommand('copy'); event.stopPropagation();"@@ -196,36 +200,37 @@ defmodule PlausibleWeb.Live.InstallationV2 do</span></a></div>-- <.button_link- :if={not is_nil(@installation_type)}- href={"/#{URI.encode_www_form(@site.domain)}/verification"}- type="submit"- class="w-full mt-8"- >- <%= if @flow == PlausibleWeb.Flows.domain_change() do %>- I understand, I'll update my website- <% else %>- <%= if @flow == PlausibleWeb.Flows.review() do %>- Verify your installation- <% else %>- Start collecting data- <% end %>- <% end %>- </.button_link></form>"""end- defp render_snippet(site) do+ def handle_event("submit", _params, socket) do+ PlausibleWeb.Tracker.update_script_configuration(+ socket.assigns.site,+ %{installation_type: socket.assigns.installation_type},+ :installation+ )++ {:noreply,+ push_navigate(socket,+ to:+ Routes.site_path(socket, :verification, socket.assigns.site.domain,+ flow: socket.assigns.flow+ )+ )}+ end++ defp render_snippet(tracker_script_configuration) do"""- <script defer src="#{tracker_url(site)}"></script>- <script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>+ <script>+ window.plausible=window.plausible||function(){(window.plausible.q=window.plausible.q||[]).push(arguments)},window.plausible.init=function(i){window.plausible.o=i||{}};var script=document.createElement("script");script.type="text/javascript",script.defer=!0,script.src="#{tracker_url(tracker_script_configuration)}";var r=document.getElementsByTagName("script")[0];r.parentNode.insertBefore(script,r);+ plausible.init()+ </script>"""end- defp tracker_url(site) do- "https://plausible.io/js/script-#{site.domain}.js"+ defp tracker_url(tracker_script_configuration) do+ "https://plausible.io/js/s-#{tracker_script_configuration.id}.js"enddefp script_icon(assigns) dodiff --git a/lib/plausible_web/tracker.ex b/lib/plausible_web/tracker.exindex c74f8e6907..c351eab8c5 100644--- a/lib/plausible_web/tracker.ex+++ b/lib/plausible_web/tracker.ex@@ -44,22 +44,29 @@ defmodule PlausibleWeb.Tracker doenddef update_script_configuration(site, config_update, changeset_type) do- original_config = get_or_create_tracker_script_configuration!(site.id)-- changeset = changeset(original_config, config_update, changeset_type)- updated_config = Repo.update!(changeset)-- sync_goals(site, original_config, updated_config)-- on_ee do- Plausible.Workers.PurgeCDNCache.new(- %{id: updated_config.id},- # See PurgeCDNCache.ex for more details- schedule_in: 10,- replace: [scheduled: [:scheduled_at]]- )- |> Oban.insert!()- end+ {:ok, updated_config} =+ Repo.transaction(fn ->+ original_config = get_or_create_tracker_script_configuration!(site.id)+ changeset = changeset(original_config, config_update, changeset_type)++ updated_config = Repo.update!(changeset)++ sync_goals(site, original_config, updated_config)++ on_ee do+ if Map.keys(changeset.changes) != [:installation_type] do+ Plausible.Workers.PurgeCDNCache.new(+ %{id: updated_config.id},+ # See PurgeCDNCache.ex for more details+ schedule_in: 10,+ replace: [scheduled: [:scheduled_at]]+ )+ |> Oban.insert!()+ end+ end++ updated_config+ end)updated_configenddiff --git a/test/plausible_web/tracker_test.exs b/test/plausible_web/tracker_test.exsindex 1503c11016..92a1bfefce 100644--- a/test/plausible_web/tracker_test.exs+++ b/test/plausible_web/tracker_test.exs@@ -1,5 +1,7 @@defmodule PlausibleWeb.TrackerTest douse Plausible.DataCase, async: true+ use Oban.Testing, repo: Plausible.Repo+ use Plausibleuse Plausible.Teams.Testalias Plausible.Site.TrackerScriptConfiguration@@ -32,6 +34,58 @@ defmodule PlausibleWeb.TrackerTest do}end+ test "can update config" do+ site = new_site()+ tracker_script_configuration = create_config(site)++ assert tracker_script_configuration.installation_type == :manual++ Tracker.update_script_configuration(+ site,+ %{installation_type: :wordpress, outbound_links: true},+ :installation+ )++ tracker_script_configuration = Repo.reload!(tracker_script_configuration)++ assert tracker_script_configuration.installation_type == :wordpress+ assert tracker_script_configuration.outbound_links == true+ end++ on_ee do+ test "CDN purge is scheduled when config is updated" do+ site = new_site()++ tracker_script_configuration =+ Tracker.get_or_create_tracker_script_configuration!(site.id)++ Tracker.update_script_configuration(+ site,+ %{installation_type: :wordpress, outbound_links: true},+ :installation+ )++ assert_enqueued(+ worker: Plausible.Workers.PurgeCDNCache,+ args: %{id: tracker_script_configuration.id}+ )+ end++ test "CDN purge is not scheduled when only installation type is updated" do+ site = new_site()++ tracker_script_configuration =+ Tracker.get_or_create_tracker_script_configuration!(site.id)++ Tracker.update_script_configuration(site, %{installation_type: :wordpress}, :installation)++ refute_enqueued(+ worker: Plausible.Workers.PurgeCDNCache,+ args: %{id: tracker_script_configuration.id}+ )+ end+ end+test "can turn config into a script tag" dosite = new_site()tracker_script_configuration = create_config(site)