Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

tracker_script_configuration: plugins API (step 5) (#5410)

Karl-Aksel Puulmannb5bd623cf1e7
diff --git a/lib/plausible/site/installation_meta.ex b/lib/plausible/site/installation_meta.ex
index 1ab46912a0..58de0d8df8 100644
--- a/lib/plausible/site/installation_meta.ex
+++ b/lib/plausible/site/installation_meta.ex
@@ -4,35 +4,10 @@ defmodule Plausible.Site.InstallationMeta do
"""
use Ecto.Schema
- alias Plausible.Site.TrackerScriptConfiguration
-
@type t() :: %__MODULE__{}
embedded_schema do
field :installation_type, :string, default: "manual"
field :script_config, :map, default: %{}
end
-
- def to_tracker_script_configuration(site, installation_meta \\ nil) do
- installation_meta =
- installation_meta || site.installation_meta || %Plausible.Site.InstallationMeta{}
-
- %TrackerScriptConfiguration{
- site_id: site.id,
- installation_type:
- Map.get(installation_meta, :installation_type) |> remap_installation_type(),
- track_404_pages: Map.get(installation_meta.script_config, "404", false),
- hash_based_routing: Map.get(installation_meta.script_config, "hash", false),
- outbound_links: Map.get(installation_meta.script_config, "outbound-links", false),
- file_downloads: Map.get(installation_meta.script_config, "file-downloads", false),
- revenue_tracking: Map.get(installation_meta.script_config, "revenue", false),
- tagged_events: Map.get(installation_meta.script_config, "tagged-events", false),
- form_submissions: Map.get(installation_meta.script_config, "form-submissions", false),
- pageview_props: Map.get(installation_meta.script_config, "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
end
diff --git a/lib/plausible/site/tracker_script_configuration.ex b/lib/plausible/site/tracker_script_configuration.ex
index 6f462829a6..2b0c1d20c3 100644
--- a/lib/plausible/site/tracker_script_configuration.ex
+++ b/lib/plausible/site/tracker_script_configuration.ex
@@ -4,7 +4,6 @@ defmodule Plausible.Site.TrackerScriptConfiguration do
"""
use Ecto.Schema
import Ecto.Changeset
- import Ecto.Query
@type t() :: %__MODULE__{}
@@ -26,7 +25,7 @@ defmodule Plausible.Site.TrackerScriptConfiguration do
timestamps()
end
- def changeset(struct, params) do
+ def installation_changeset(struct, params) do
struct
|> cast(params, [
:installation_type,
@@ -43,41 +42,16 @@ defmodule Plausible.Site.TrackerScriptConfiguration do
|> validate_required([:site_id])
end
- def upsert(configuration_map) do
- changeset = changeset(%__MODULE__{}, configuration_map)
-
- Plausible.Repo.insert(
- changeset,
- on_conflict: {:replace, fields_to_update(configuration_map)},
- conflict_target: [:site_id],
- returning: true
- )
- 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) do
- fields = __MODULE__.__schema__(:fields)
-
- configuration_map
- |> Map.keys()
- |> Enum.map(fn
- key when is_atom(key) -> key
- key when is_binary(key) -> String.to_existing_atom(key)
- end)
- |> Enum.filter(&(&1 in fields))
- |> Enum.concat([:updated_at])
+ def plugins_api_changeset(struct, params) do
+ struct
+ |> cast(params, [
+ :installation_type,
+ :hash_based_routing,
+ :outbound_links,
+ :file_downloads,
+ :form_submissions,
+ :site_id
+ ])
+ |> validate_required([:site_id])
end
end
diff --git a/lib/plausible_web/live/installation.ex b/lib/plausible_web/live/installation.ex
index 73010908e1..edf0643bd9 100644
--- a/lib/plausible_web/live/installation.ex
+++ b/lib/plausible_web/live/installation.ex
@@ -4,7 +4,6 @@ defmodule PlausibleWeb.Live.Installation do
"""
use PlausibleWeb, :live_view
alias Plausible.Verification.{Checks, State}
- alias Plausible.Site.TrackerScriptConfiguration
@script_extension_params %{
"outbound_links" => "outbound-links",
@@ -50,7 +49,9 @@ defmodule PlausibleWeb.Live.Installation do
flow = params["flow"]
- tracker_script_configuration = TrackerScriptConfiguration.get_or_create!(site.id)
+ tracker_script_configuration =
+ PlausibleWeb.Tracker.get_or_create_tracker_script_configuration!(site.id)
+
installation_type = get_installation_type(flow, tracker_script_configuration, params)
config =
@@ -498,7 +499,7 @@ defmodule PlausibleWeb.Live.Installation do
end
defp persist_tracker_script_configuration(socket) do
- updated_tracker_script_configuration =
+ tracker_script_config_update =
Map.merge(socket.assigns.config, %{
"site_id" => socket.assigns.site.id,
"installation_type" => socket.assigns.installation_type
@@ -506,7 +507,8 @@ defmodule PlausibleWeb.Live.Installation do
PlausibleWeb.Tracker.update_script_configuration(
socket.assigns.site,
- updated_tracker_script_configuration
+ tracker_script_config_update,
+ :installation
)
socket
diff --git a/lib/plausible_web/plugins/api/controllers/tracker_script_configuration.ex b/lib/plausible_web/plugins/api/controllers/tracker_script_configuration.ex
new file mode 100644
index 0000000000..0579002ccc
--- /dev/null
+++ b/lib/plausible_web/plugins/api/controllers/tracker_script_configuration.ex
@@ -0,0 +1,53 @@
+defmodule PlausibleWeb.Plugins.API.Controllers.TrackerScriptConfiguration do
+ @moduledoc """
+ Controller for the Tracker Script Configuration resource under Plugins API
+ """
+ use PlausibleWeb, :plugins_api_controller
+
+ operation(:get,
+ summary: "Retrieve Tracker Script Configuration",
+ parameters: [],
+ responses: %{
+ ok:
+ {"Tracker Script Configuration response", "application/json",
+ Schemas.TrackerScriptConfiguration},
+ unauthorized: {"Unauthorized", "application/json", Schemas.Unauthorized}
+ }
+ )
+
+ @spec get(Plug.Conn.t(), %{}) :: Plug.Conn.t()
+ def get(conn, _params) do
+ site = conn.assigns.authorized_site
+ configuration = PlausibleWeb.Tracker.get_or_create_tracker_script_configuration!(site.id)
+
+ conn
+ |> put_view(Views.TrackerScriptConfiguration)
+ |> render("tracker_script_configuration.json", tracker_script_configuration: configuration)
+ end
+
+ operation(:update,
+ summary: "Update Tracker Script Configuration",
+ request_body:
+ {"Tracker Script Configuration params", "application/json",
+ Schemas.TrackerScriptConfiguration.UpdateRequest},
+ responses: %{
+ ok:
+ {"Tracker Script Configuration", "application/json", Schemas.TrackerScriptConfiguration},
+ unauthorized: {"Unauthorized", "application/json", Schemas.Unauthorized}
+ }
+ )
+
+ @spec update(Plug.Conn.t(), map()) :: Plug.Conn.t()
+ def update(conn, %{"tracker_script_configuration" => update_params}) do
+ site = conn.assigns.authorized_site
+
+ update_params = Map.put(update_params, "site_id", site.id)
+
+ updated_config =
+ PlausibleWeb.Tracker.update_script_configuration(site, update_params, :plugins_api)
+
+ conn
+ |> put_view(Views.TrackerScriptConfiguration)
+ |> render("tracker_script_configuration.json", tracker_script_configuration: updated_config)
+ end
+end
diff --git a/lib/plausible_web/plugins/api/schemas/tracker_script_configuration.ex b/lib/plausible_web/plugins/api/schemas/tracker_script_configuration.ex
new file mode 100644
index 0000000000..4087621f14
--- /dev/null
+++ b/lib/plausible_web/plugins/api/schemas/tracker_script_configuration.ex
@@ -0,0 +1,47 @@
+defmodule PlausibleWeb.Plugins.API.Schemas.TrackerScriptConfiguration do
+ @moduledoc """
+ OpenAPI schema for TrackerScriptConfiguration object
+ """
+ use PlausibleWeb, :open_api_schema
+
+ OpenApiSpex.schema(%{
+ description: "Tracker Script Configuration object",
+ type: :object,
+ required: [:tracker_script_configuration],
+ properties: %{
+ tracker_script_configuration: %Schema{
+ type: :object,
+ required: [
+ :id,
+ :installation_type,
+ :hash_based_routing,
+ :outbound_links,
+ :file_downloads,
+ :form_submissions
+ ],
+ properties: %{
+ id: %Schema{type: :string, description: "Tracker Script Configuration ID"},
+ installation_type: %Schema{
+ type: :string,
+ description: "Tracker Script Installation Type",
+ enum: ["manual", "wordpress", "gtm"]
+ },
+ hash_based_routing: %Schema{type: :boolean, description: "Hash Based Routing"},
+ outbound_links: %Schema{type: :boolean, description: "Track Outbound Links"},
+ file_downloads: %Schema{type: :boolean, description: "Track File Downloads"},
+ form_submissions: %Schema{type: :boolean, description: "Track Form Submissions"}
+ }
+ }
+ },
+ example: %{
+ tracker_script_configuration: %{
+ id: "qyhkWtOWaTN0YPkhrcJgy",
+ installation_type: "wordpress",
+ hash_based_routing: true,
+ outbound_links: false,
+ file_downloads: true,
+ form_submissions: false
+ }
+ }
+ })
+end
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.ex
new file mode 100644
index 0000000000..2a3178d66d
--- /dev/null
+++ b/lib/plausible_web/plugins/api/schemas/tracker_script_configuration/update_request.ex
@@ -0,0 +1,33 @@
+defmodule PlausibleWeb.Plugins.API.Schemas.TrackerScriptConfiguration.UpdateRequest do
+ @moduledoc """
+ OpenAPI schema for TrackerScriptConfiguration update request
+ """
+ use PlausibleWeb, :open_api_schema
+
+ OpenApiSpex.schema(%{
+ title: "TrackerScriptConfiguration.UpdateRequest",
+ description: "Tracker Script Configuration update params",
+ type: :object,
+ required: [:tracker_script_configuration],
+ properties: %{
+ tracker_script_configuration: %Schema{
+ type: :object,
+ required: [:installation_type],
+ properties: %{
+ installation_type: %Schema{
+ type: :string,
+ description: "Tracker Script Installation Type",
+ enum: ["manual", "wordpress", "gtm"]
+ },
+ hash_based_routing: %Schema{type: :boolean, description: "Hash Based Routing"},
+ outbound_links: %Schema{type: :boolean, description: "Track Outbound Links"},
+ file_downloads: %Schema{type: :boolean, description: "Track File Downloads"},
+ form_submissions: %Schema{type: :boolean, description: "Track Form Submissions"}
+ }
+ }
+ },
+ example: %{
+ tracker_script_configuration: %{installation_type: "wordpress", hash_based_routing: true}
+ }
+ })
+end
diff --git a/lib/plausible_web/plugins/api/views/tracker_script_configuration.ex b/lib/plausible_web/plugins/api/views/tracker_script_configuration.ex
new file mode 100644
index 0000000000..b69677f1b9
--- /dev/null
+++ b/lib/plausible_web/plugins/api/views/tracker_script_configuration.ex
@@ -0,0 +1,22 @@
+defmodule PlausibleWeb.Plugins.API.Views.TrackerScriptConfiguration do
+ @moduledoc """
+ View for rendering Tracker Script Configuration in the Plugins API
+ """
+
+ use PlausibleWeb, :plugins_api_view
+
+ def render("tracker_script_configuration.json", %{
+ tracker_script_configuration: tracker_script_configuration
+ }) do
+ %{
+ tracker_script_configuration: %{
+ id: tracker_script_configuration.id,
+ installation_type: tracker_script_configuration.installation_type || :manual,
+ hash_based_routing: tracker_script_configuration.hash_based_routing,
+ outbound_links: tracker_script_configuration.outbound_links,
+ file_downloads: tracker_script_configuration.file_downloads,
+ form_submissions: tracker_script_configuration.form_submissions
+ }
+ }
+ end
+end
diff --git a/lib/plausible_web/router.ex b/lib/plausible_web/router.ex
index 50ad3a9f3d..f18700fdbc 100644
--- a/lib/plausible_web/router.ex
+++ b/lib/plausible_web/router.ex
@@ -205,6 +205,9 @@ defmodule PlausibleWeb.Router do
put("/custom_props", CustomProps, :enable)
delete("/custom_props", CustomProps, :disable)
+
+ get("/tracker_script_configuration", TrackerScriptConfiguration, :get)
+ put("/tracker_script_configuration", TrackerScriptConfiguration, :update)
end
end
diff --git a/lib/plausible_web/tracker.ex b/lib/plausible_web/tracker.ex
index 0d788ba7e7..334a06c6e0 100644
--- a/lib/plausible_web/tracker.ex
+++ b/lib/plausible_web/tracker.ex
@@ -46,29 +46,48 @@ defmodule PlausibleWeb.Tracker do
}
end
- def update_script_configuration(site, config_update) do
- {:ok, updated_config} = TrackerScriptConfiguration.upsert(config_update)
+ def update_script_configuration(site, config_update, changeset_type) do
+ original_config = get_or_create_tracker_script_configuration!(site.id)
- sync_goals(site, config_update)
+ changeset = changeset(original_config, config_update, changeset_type)
+ updated_config = Repo.update!(changeset)
+
+ sync_goals(site, original_config, updated_config)
updated_config
end
+ def get_or_create_tracker_script_configuration!(site_id) do
+ configuration = Repo.get_by(TrackerScriptConfiguration, site_id: site_id)
+
+ if configuration do
+ configuration
+ else
+ %TrackerScriptConfiguration{site_id: site_id}
+ |> Repo.insert!()
+ end
+ end
+
# Sync plausible goals with the updated script config
- defp sync_goals(site, config_update) do
- config_update
- |> Enum.map(fn {key, value} -> {to_atom(key), value} end)
+ defp sync_goals(site, original_config, updated_config) do
+ [:track_404_pages, :outbound_links, :file_downloads]
+ |> Enum.map(fn key -> {key, Map.get(original_config, key), Map.get(updated_config, key)} end)
|> Enum.each(fn
- {:track_404_pages, true} -> Plausible.Goals.create_404(site)
- {:track_404_pages, false} -> Plausible.Goals.delete_404(site)
- {:outbound_links, true} -> Plausible.Goals.create_outbound_links(site)
- {:outbound_links, false} -> Plausible.Goals.delete_outbound_links(site)
- {:file_downloads, true} -> Plausible.Goals.create_file_downloads(site)
- {:file_downloads, false} -> Plausible.Goals.delete_file_downloads(site)
+ {:track_404_pages, false, true} -> Plausible.Goals.create_404(site)
+ {:track_404_pages, true, false} -> Plausible.Goals.delete_404(site)
+ {:outbound_links, false, true} -> Plausible.Goals.create_outbound_links(site)
+ {:outbound_links, true, false} -> Plausible.Goals.delete_outbound_links(site)
+ {:file_downloads, false, true} -> Plausible.Goals.create_file_downloads(site)
+ {:file_downloads, true, false} -> Plausible.Goals.delete_file_downloads(site)
_ -> nil
end)
end
- defp to_atom(str) when is_binary(str), do: String.to_existing_atom(str)
- defp to_atom(atom) when is_atom(atom), do: atom
+ defp changeset(tracker_script_configuration, config_update, :installation) do
+ TrackerScriptConfiguration.installation_changeset(tracker_script_configuration, config_update)
+ end
+
+ defp changeset(tracker_script_configuration, config_update, :plugins_api) do
+ TrackerScriptConfiguration.plugins_api_changeset(tracker_script_configuration, config_update)
+ end
end
diff --git a/test/plausible/site/tracker_script_configuration_test.exs b/test/plausible/site/tracker_script_configuration_test.exs
deleted file mode 100644
index 5ad3d565da..0000000000
--- a/test/plausible/site/tracker_script_configuration_test.exs
+++ /dev/null
@@ -1,59 +0,0 @@
-defmodule Plausible.Site.TrackerScriptConfigurationTest do
- use Plausible
- use Plausible.DataCase, async: true
- use Plausible.Teams.Test
-
- alias Plausible.Site.TrackerScriptConfiguration
-
- test "#upsert/2" do
- site = insert(:site)
-
- {:ok, initial_configuration} =
- TrackerScriptConfiguration.upsert(%{
- site_id: site.id,
- installation_type: nil,
- track_404_pages: true,
- hash_based_routing: true,
- outbound_links: true,
- pageview_props: true
- })
-
- assert_matches %{
- id: ^any(:string),
- site_id: ^site.id,
- installation_type: nil,
- track_404_pages: true,
- hash_based_routing: true,
- outbound_links: true,
- file_downloads: false,
- revenue_tracking: false,
- tagged_events: false,
- form_submissions: false,
- pageview_props: true
- } = initial_configuration
-
- {:ok, updated_configuration} =
- TrackerScriptConfiguration.upsert(%{
- site_id: site.id,
- installation_type: :wordpress,
- track_404_pages: false,
- outbound_links: true,
- file_downloads: true,
- pageview_props: false
- })
-
- assert_matches %{
- id: ^initial_configuration.id,
- site_id: ^site.id,
- installation_type: :wordpress,
- track_404_pages: false,
- hash_based_routing: true,
- outbound_links: true,
- file_downloads: true,
- revenue_tracking: false,
- tagged_events: false,
- form_submissions: false,
- pageview_props: false
- } = updated_configuration
- end
-end
diff --git a/test/plausible_web/live/installation_test.exs b/test/plausible_web/live/installation_test.exs
index b985f24427..a98fd09fb1 100644
--- a/test/plausible_web/live/installation_test.exs
+++ b/test/plausible_web/live/installation_test.exs
@@ -4,6 +4,8 @@ defmodule PlausibleWeb.Live.InstallationTest do
import Phoenix.LiveViewTest
import Plausible.Test.Support.HTML
+ alias Plausible.Site.TrackerScriptConfiguration
+
setup [:create_user, :log_in, :create_site]
describe "GET /:domain/installation" do
@@ -30,11 +32,10 @@ defmodule PlausibleWeb.Live.InstallationTest do
end
test "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
- })
+ Plausible.Repo.insert!(%TrackerScriptConfiguration{
+ site_id: site.id,
+ installation_type: :manual
+ })
resp =
conn
@@ -54,11 +55,10 @@ defmodule PlausibleWeb.Live.InstallationTest do
test "static verification screen renders for flow=domain_change using original installation type",
%{conn: conn, site: site} do
- {:ok, _} =
- Plausible.Site.TrackerScriptConfiguration.upsert(%{
- site_id: site.id,
- installation_type: :wordpress
- })
+ Plausible.Repo.insert!(%TrackerScriptConfiguration{
+ site_id: site.id,
+ installation_type: :wordpress
+ })
resp =
conn
diff --git a/test/plausible_web/plugins/api/controllers/tracker_script_configuration_test.exs b/test/plausible_web/plugins/api/controllers/tracker_script_configuration_test.exs
new file mode 100644
index 0000000000..c61a257749
--- /dev/null
+++ b/test/plausible_web/plugins/api/controllers/tracker_script_configuration_test.exs
@@ -0,0 +1,217 @@
+defmodule PlausibleWeb.Plugins.API.Controllers.TrackerScriptConfigurationTest do
+ use PlausibleWeb.PluginsAPICase, async: true
+ use Plausible.Teams.Test
+ import Plausible.AssertMatches
+ alias PlausibleWeb.Plugins.API.Schemas
+
+ describe "examples" do
+ test "TrackerScriptConfiguration" do
+ assert_schema(
+ Schemas.TrackerScriptConfiguration.schema().example,
+ "TrackerScriptConfiguration",
+ spec()
+ )
+ end
+
+ test "TrackerScriptConfiguration.UpdateRequest" do
+ assert_schema(
+ Schemas.TrackerScriptConfiguration.UpdateRequest.schema().example,
+ "TrackerScriptConfiguration.UpdateRequest",
+ spec()
+ )
+ end
+ end
+
+ describe "unauthorized calls" do
+ for {method, url} <- [
+ {:get,
+ Routes.plugins_api_tracker_script_configuration_url(PlausibleWeb.Endpoint, :get)},
+ {:put,
+ Routes.plugins_api_tracker_script_configuration_url(
+ PlausibleWeb.Endpoint,
+ :update,
+ %{}
+ )}
+ ] do
+ test "unauthorized call: #{method} #{url}", %{conn: conn} do
+ conn
+ |> unquote(method)(unquote(url))
+ |> json_response(401)
+ |> assert_schema("UnauthorizedError", spec())
+ end
+ end
+ end
+
+ describe "get/put /tracker_script_configuration" do
+ test "inserts a new tracker script configuration if one doesn't exist and returns it consistently",
+ %{conn: conn, token: token, site: site} do
+ initial_resp = get_tracker_script_configuration(conn, site, token)
+
+ id = initial_resp.tracker_script_configuration.id
+
+ assert_matches ^strict_map(%{
+ id: ^any(:string),
+ installation_type: "manual",
+ hash_based_routing: false,
+ outbound_links: false,
+ file_downloads: false,
+ form_submissions: false
+ }) = initial_resp.tracker_script_configuration
+
+ resp = get_tracker_script_configuration(conn, site, token)
+
+ assert_matches ^strict_map(%{
+ id: ^id,
+ installation_type: "manual",
+ hash_based_routing: false,
+ outbound_links: false,
+ file_downloads: false,
+ form_submissions: false
+ }) = resp.tracker_script_configuration
+ end
+
+ test "both return updated tracker script configuration", %{
+ conn: conn,
+ token: token,
+ site: site
+ } do
+ update_response =
+ update_tracker_script_configuration(conn, site, token, %{
+ tracker_script_configuration: %{
+ installation_type: "manual",
+ file_downloads: true
+ }
+ })
+
+ get_response = get_tracker_script_configuration(conn, site, token)
+
+ assert get_response == update_response
+
+ assert_matches ^strict_map(%{
+ id: ^update_response.tracker_script_configuration.id,
+ installation_type: "manual",
+ hash_based_routing: false,
+ outbound_links: false,
+ file_downloads: true,
+ form_submissions: false
+ }) = get_response.tracker_script_configuration
+ end
+
+ test "multiple updates only overwrite the specified fields", %{
+ conn: conn,
+ token: token,
+ site: site
+ } do
+ update_tracker_script_configuration(conn, site, token, %{
+ tracker_script_configuration: %{
+ installation_type: "manual",
+ hash_based_routing: true,
+ outbound_links: true,
+ file_downloads: true,
+ form_submissions: true
+ }
+ })
+
+ update_response =
+ update_tracker_script_configuration(conn, site, token, %{
+ tracker_script_configuration: %{
+ installation_type: "wordpress",
+ hash_based_routing: false
+ }
+ })
+
+ assert_matches ^strict_map(%{
+ id: ^any(:string),
+ installation_type: "wordpress",
+ hash_based_routing: false,
+ outbound_links: true,
+ file_downloads: true,
+ form_submissions: true
+ }) = update_response.tracker_script_configuration
+ end
+
+ test "ignores unknown fields", %{conn: conn, token: token, site: site} do
+ response =
+ update_tracker_script_configuration(conn, site, token, %{
+ tracker_script_configuration: %{
+ installation_type: "wordpress",
+ hash_based_routing: true,
+ unknown_field: "unknown_value"
+ }
+ })
+
+ assert_matches ^strict_map(%{
+ id: ^any(:string),
+ installation_type: "wordpress",
+ hash_based_routing: true,
+ outbound_links: false,
+ file_downloads: false,
+ form_submissions: false
+ }) = response.tracker_script_configuration
+ end
+
+ test "installation_type parameter is required", %{conn: conn, token: token, site: site} do
+ url = Routes.plugins_api_tracker_script_configuration_url(PlausibleWeb.Endpoint, :update)
+
+ payload = %{tracker_script_configuration: %{hash_based_routing: true}}
+
+ response =
+ conn
+ |> authenticate(site.domain, token)
+ |> put_req_header("content-type", "application/json")
+ |> put(url, payload)
+ |> json_response(422)
+ |> assert_schema("UnprocessableEntityError", spec())
+
+ assert %{errors: [%{detail: "Missing field: installation_type"}]} = response
+ end
+
+ test "installation_type and boolean parameters are validated", %{
+ conn: conn,
+ token: token,
+ site: site
+ } do
+ url = Routes.plugins_api_tracker_script_configuration_url(PlausibleWeb.Endpoint, :update)
+
+ payload = %{
+ tracker_script_configuration: %{installation_type: "unknown", hash_based_routing: "1234"}
+ }
+
+ response =
+ conn
+ |> authenticate(site.domain, token)
+ |> put_req_header("content-type", "application/json")
+ |> put(url, payload)
+ |> json_response(422)
+ |> assert_schema("UnprocessableEntityError", spec())
+
+ assert %{
+ errors: [
+ %{detail: "Invalid value for enum"},
+ %{detail: "Invalid boolean. Got: string"}
+ ]
+ } = response
+ end
+ end
+
+ defp get_tracker_script_configuration(conn, site, token) do
+ url = Routes.plugins_api_tracker_script_configuration_url(PlausibleWeb.Endpoint, :get)
+
+ conn
+ |> authenticate(site.domain, token)
+ |> get(url)
+ |> json_response(200)
+ |> assert_schema("TrackerScriptConfiguration", spec())
+ end
+
+ defp update_tracker_script_configuration(conn, site, token, payload) do
+ url = Routes.plugins_api_tracker_script_configuration_url(PlausibleWeb.Endpoint, :update)
+
+ conn
+ |> authenticate(site.domain, token)
+ |> put_req_header("content-type", "application/json")
+ |> put(url, payload)
+ |> json_response(200)
+ |> assert_schema("TrackerScriptConfiguration", spec())
+ end
+end
diff --git a/test/plausible_web/plugs/tracker_plug_test.exs b/test/plausible_web/plugs/tracker_plug_test.exs
index fa24503ea4..d2a3733da2 100644
--- a/test/plausible_web/plugs/tracker_plug_test.exs
+++ b/test/plausible_web/plugs/tracker_plug_test.exs
@@ -17,7 +17,7 @@ defmodule PlausibleWeb.TrackerPlugTest do
use Plug.Test
use Plausible.Teams.Test
- alias Plausible.Site.TrackerScriptConfiguration
+ alias PlausibleWeb.Tracker
describe "plausible-main.js" do
@example_config %{
@@ -34,8 +34,12 @@ defmodule PlausibleWeb.TrackerPlugTest do
test "returns the script for an existing site", %{conn: conn} do
site = new_site()
- {:ok, tracker_script_configuration} =
- TrackerScriptConfiguration.upsert(Map.put(@example_config, :site_id, site.id))
+ tracker_script_configuration =
+ Tracker.update_script_configuration(
+ site,
+ Map.put(@example_config, :site_id, site.id),
+ :installation
+ )
response = get(conn, "/js/s-#{tracker_script_configuration.id}.js") |> response(200)
@@ -50,8 +54,12 @@ defmodule PlausibleWeb.TrackerPlugTest do
test "script contains window.plausible", %{conn: conn} do
site = new_site()
- {:ok, tracker_script_configuration} =
- TrackerScriptConfiguration.upsert(Map.put(@example_config, :site_id, site.id))
+ tracker_script_configuration =
+ Tracker.update_script_configuration(
+ site,
+ Map.put(@example_config, :site_id, site.id),
+ :installation
+ )
response = get(conn, "/js/s-#{tracker_script_configuration.id}.js") |> response(200)
diff --git a/test/plausible_web/tracker_test.exs b/test/plausible_web/tracker_test.exs
index 49d6b50daa..751559b4ec 100644
--- a/test/plausible_web/tracker_test.exs
+++ b/test/plausible_web/tracker_test.exs
@@ -3,6 +3,7 @@ defmodule PlausibleWeb.TrackerTest do
use Plausible.Teams.Test
alias Plausible.Site.TrackerScriptConfiguration
+ alias PlausibleWeb.Tracker
describe "plausible-main.js" do
@example_config %{
@@ -52,7 +53,11 @@ defmodule PlausibleWeb.TrackerTest do
end
def create_config(site) do
- {:ok, _} = TrackerScriptConfiguration.upsert(Map.put(@example_config, :site_id, site.id))
+ Tracker.update_script_configuration(
+ site,
+ Map.put(@example_config, :site_id, site.id),
+ :installation
+ )
Plausible.Repo.one(
from(c in TrackerScriptConfiguration, where: c.site_id == ^site.id, preload: [:site])