Skip to content

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

Refactor passing params to structs during provisioning (#6402)

Adrian Gruntkowski05609e119755
diff --git a/lib/plausible/goal.ex b/lib/plausible/goal.ex
index f5900aff9b..04c0407bab 100644
--- a/lib/plausible/goal.ex
+++ b/lib/plausible/goal.ex
@@ -38,8 +38,6 @@ defmodule Plausible.Goal do
end
@fields [
- :id,
- :site_id,
:event_name,
:page_path,
:scroll_threshold,
@@ -59,8 +57,6 @@ defmodule Plausible.Goal do
def changeset(goal, attrs \\ %{}) do
goal
|> cast(attrs, @fields)
- |> validate_required([:site_id])
- |> cast_assoc(:site)
|> update_leading_slash()
|> validate_event_name_and_page_path()
|> validate_page_path_for_scroll_goal()
diff --git a/lib/plausible/goals/goals.ex b/lib/plausible/goals/goals.ex
index d6d3db86a1..e79e278927 100644
--- a/lib/plausible/goals/goals.ex
+++ b/lib/plausible/goals/goals.ex
@@ -1,4 +1,8 @@
defmodule Plausible.Goals do
+ @moduledoc """
+ Goals API.
+ """
+
use Plausible
use Plausible.Repo
use Plausible.Funnel.Const
@@ -371,7 +375,10 @@ defmodule Plausible.Goals do
[]
end
- changeset = Goal.changeset(%Goal{site_id: site.id}, params)
+ changeset =
+ %Goal{}
+ |> Goal.changeset(params)
+ |> Ecto.Changeset.put_assoc(:site, site)
with :ok <- maybe_check_feature_access(site, changeset),
:ok <- check_no_currency_if_consolidated(site, changeset),
diff --git a/lib/plausible/segments/segment.ex b/lib/plausible/segments/segment.ex
index 8fd5b8ac2e..1187714013 100644
--- a/lib/plausible/segments/segment.ex
+++ b/lib/plausible/segments/segment.ex
@@ -29,7 +29,6 @@ defmodule Plausible.Segments.Segment do
|> cast(attrs, [
:name,
:segment_data,
- :site_id,
:type,
:owner_id
])
diff --git a/lib/plausible/segments/segments.ex b/lib/plausible/segments/segments.ex
index bf50d72b3b..de247316b4 100644
--- a/lib/plausible/segments/segments.ex
+++ b/lib/plausible/segments/segments.ex
@@ -158,8 +158,8 @@ defmodule Plausible.Segments do
with :ok <- can_insert_one?(site, site_role, params),
%{valid?: true} = changeset <-
Segment.changeset(
- %Segment{},
- Map.merge(params, %{"site_id" => site.id, "owner_id" => user_id})
+ %Segment{site_id: site.id},
+ Map.merge(params, %{"owner_id" => user_id})
),
:ok <-
Segment.validate_segment_data(site, params["segment_data"], true) do
diff --git a/lib/plausible/shield/country_rule.ex b/lib/plausible/shield/country_rule.ex
index 1329f74bda..a9234363eb 100644
--- a/lib/plausible/shield/country_rule.ex
+++ b/lib/plausible/shield/country_rule.ex
@@ -26,8 +26,8 @@ defmodule Plausible.Shield.CountryRule do
def changeset(rule, attrs) do
rule
- |> cast(attrs, [:site_id, :country_code])
- |> validate_required([:site_id, :country_code])
+ |> cast(attrs, [:country_code])
+ |> validate_required([:country_code])
|> validate_length(:country_code, is: 2)
|> validate_change(:country_code, fn :country_code, cc ->
valid_codes = [@unknown_country_code | Enum.map(Location.Country.all(), & &1.alpha_2)]
diff --git a/lib/plausible/shield/hostname_rule.ex b/lib/plausible/shield/hostname_rule.ex
index 27d212ff5c..2f7f5295cd 100644
--- a/lib/plausible/shield/hostname_rule.ex
+++ b/lib/plausible/shield/hostname_rule.ex
@@ -22,8 +22,8 @@ defmodule Plausible.Shield.HostnameRule do
def changeset(rule \\ %__MODULE__{}, attrs) do
rule
- |> cast(attrs, [:site_id, :hostname])
- |> validate_required([:site_id, :hostname])
+ |> cast(attrs, [:hostname])
+ |> validate_required([:hostname])
|> validate_length(:hostname, max: 250)
|> store_regex()
|> unique_constraint(:hostname_pattern,
diff --git a/lib/plausible/shield/ip_rule.ex b/lib/plausible/shield/ip_rule.ex
index 9f160f2f6d..fa725e99e3 100644
--- a/lib/plausible/shield/ip_rule.ex
+++ b/lib/plausible/shield/ip_rule.ex
@@ -22,8 +22,8 @@ defmodule Plausible.Shield.IPRule do
def changeset(rule, attrs) do
rule
- |> cast(attrs, [:site_id, :inet, :description])
- |> validate_required([:site_id, :inet])
+ |> cast(attrs, [:inet, :description])
+ |> validate_required([:inet])
|> disallow_netmask(:inet)
|> unique_constraint(:inet,
name: :shield_rules_ip_site_id_inet_index
diff --git a/lib/plausible/shield/page_rule.ex b/lib/plausible/shield/page_rule.ex
index 0a238b75b6..d56c8f2fec 100644
--- a/lib/plausible/shield/page_rule.ex
+++ b/lib/plausible/shield/page_rule.ex
@@ -22,8 +22,8 @@ defmodule Plausible.Shield.PageRule do
def changeset(rule \\ %__MODULE__{}, attrs) do
rule
- |> cast(attrs, [:site_id, :page_path])
- |> validate_required([:site_id, :page_path])
+ |> cast(attrs, [:page_path])
+ |> validate_required([:page_path])
|> validate_length(:page_path, max: 250)
|> validate_change(:page_path, fn :page_path, p ->
if not String.starts_with?(p, "/") do
diff --git a/lib/plausible_web/live/shared_link_settings.ex b/lib/plausible_web/live/shared_link_settings.ex
index ba87d3edd9..dabe7478b6 100644
--- a/lib/plausible_web/live/shared_link_settings.ex
+++ b/lib/plausible_web/live/shared_link_settings.ex
@@ -185,13 +185,19 @@ defmodule PlausibleWeb.Live.SharedLinkSettings do
end
def handle_event("edit-shared-link", %{"slug" => slug}, socket) do
+ site_id = socket.assigns.site.id
+
shared_link =
Plausible.Site.SharedLink
- |> Plausible.Repo.get_by(slug: slug)
+ |> Plausible.Repo.get_by(slug: slug, site_id: site_id)
|> Plausible.Repo.preload(:segment)
socket =
- socket |> assign(form_shared_link: shared_link) |> Modal.open("shared-links-form-modal")
+ if shared_link do
+ socket |> assign(form_shared_link: shared_link) |> Modal.open("shared-links-form-modal")
+ else
+ put_live_flash(socket, :error, "Could not find Shared Link")
+ end
{:noreply, socket}
end
diff --git a/test/plausible/goals_test.exs b/test/plausible/goals_test.exs
index 16ace3c2b7..a254221ea2 100644
--- a/test/plausible/goals_test.exs
+++ b/test/plausible/goals_test.exs
@@ -457,6 +457,22 @@ defmodule Plausible.GoalsTest do
assert goal2.display_name == "Homepage"
end
+ test "update/2 cannot move goal to another site by passing site_id param" do
+ site = new_site()
+ victim_site = new_site()
+ {:ok, goal} = Goals.create(site, %{"event_name" => "Purchase"})
+
+ {:ok, _updated} =
+ Goals.update(goal, %{
+ "event_name" => "Purchase",
+ "site_id" => victim_site.id
+ })
+
+ reloaded = Plausible.Repo.reload!(goal)
+ assert reloaded.site_id == site.id
+ assert reloaded.site_id != victim_site.id
+ end
+
test "update/2 also updates all segments the goal is a part of" do
user = new_user()
site = new_site(owner: user)
@@ -657,7 +673,7 @@ defmodule Plausible.GoalsTest do
refute Plausible.Funnels.get(site.id, f2.id)
assert Repo.all(from(fs in Plausible.Funnel.Step, where: fs.funnel_id == ^f2.id)) == []
- assert [^g3, ^g2] = Goals.for_site(site)
+ assert_matches [%{id: ^g3.id}, %{id: ^g2.id}] = Goals.for_site(site)
end
end
diff --git a/test/plausible/shields/country_test.exs b/test/plausible/shields/country_test.exs
index 801eb7c6c3..406341799d 100644
--- a/test/plausible/shields/country_test.exs
+++ b/test/plausible/shields/country_test.exs
@@ -82,6 +82,16 @@ defmodule Plausible.Shields.CountryTest do
assert rule.added_by == "Joe <[email protected]>"
end
+
+ test "ignores site_id supplied in params", %{site: site} do
+ victim = insert(:site)
+
+ assert {:ok, rule} =
+ add_country_rule(site, %{"country_code" => "US", "site_id" => victim.id})
+
+ assert rule.site_id == site.id
+ assert count_country_rules(victim) == 0
+ end
end
describe "remove_country_rule/2" do
diff --git a/test/plausible/shields/hostname_test.exs b/test/plausible/shields/hostname_test.exs
index 75c7ca9951..bbcc0c9137 100644
--- a/test/plausible/shields/hostname_test.exs
+++ b/test/plausible/shields/hostname_test.exs
@@ -88,6 +88,16 @@ defmodule Plausible.Shields.HostnameTest do
assert rule.added_by == "Joe <[email protected]>"
end
+
+ test "ignores site_id supplied in params", %{site: site} do
+ victim = insert(:site)
+
+ assert {:ok, rule} =
+ add_hostname_rule(site, %{"hostname" => "example.com", "site_id" => victim.id})
+
+ assert rule.site_id == site.id
+ assert count_hostname_rules(victim) == 0
+ end
end
describe "hostname pattern matching" do
diff --git a/test/plausible/shields/ip_test.exs b/test/plausible/shields/ip_test.exs
index bd597a3925..af27a14133 100644
--- a/test/plausible/shields/ip_test.exs
+++ b/test/plausible/shields/ip_test.exs
@@ -87,6 +87,13 @@ defmodule Plausible.Shields.IPTest do
assert rule.added_by == "Joe <[email protected]>"
end
+
+ test "ignores site_id supplied in params", %{site: site} do
+ victim = insert(:site)
+ assert {:ok, rule} = add_ip_rule(site, %{"inet" => "1.2.3.4", "site_id" => victim.id})
+ assert rule.site_id == site.id
+ assert count_ip_rules(victim) == 0
+ end
end
describe "remove_ip_rule/2" do
diff --git a/test/plausible/shields/page_test.exs b/test/plausible/shields/page_test.exs
index 121672568f..4c4ef6abfa 100644
--- a/test/plausible/shields/page_test.exs
+++ b/test/plausible/shields/page_test.exs
@@ -94,6 +94,13 @@ defmodule Plausible.Shields.PageTest do
assert rule.added_by == "Joe <[email protected]>"
end
+
+ test "ignores site_id supplied in params", %{site: site} do
+ victim = insert(:site)
+ assert {:ok, rule} = add_page_rule(site, %{"page_path" => "/test", "site_id" => victim.id})
+ assert rule.site_id == site.id
+ assert count_page_rules(victim) == 0
+ end
end
describe "page pattern matching" do
diff --git a/test/plausible_web/controllers/api/internal_controller/segments_controller_test.exs b/test/plausible_web/controllers/api/internal_controller/segments_controller_test.exs
index 8f497bd31c..e73d58a3cf 100644
--- a/test/plausible_web/controllers/api/internal_controller/segments_controller_test.exs
+++ b/test/plausible_web/controllers/api/internal_controller/segments_controller_test.exs
@@ -397,6 +397,26 @@ defmodule PlausibleWeb.Api.Internal.SegmentsControllerTest do
"updated_at" => ^any(:iso8601_naive_datetime)
}) = response
end
+
+ test "cannot move segment to another site by passing site_id param", %{
+ conn: conn,
+ user: user,
+ site: site
+ } do
+ victim_site = new_site()
+ segment = insert(:segment, site: site, owner: user, type: :personal, name: "test segment")
+
+ patch(conn, "/api/#{site.domain}/segments/#{segment.id}", %{
+ "name" => "updated name",
+ "type" => "personal",
+ "segment_data" => %{"filters" => [["is", "visit:entry_page", ["/blog"]]], "labels" => %{}},
+ "site_id" => victim_site.id
+ })
+
+ reloaded = Repo.reload!(segment)
+ assert reloaded.site_id == site.id
+ assert reloaded.site_id != victim_site.id
+ end
end
describe "DELETE /api/:domain/segments/:segment_id" do
diff --git a/test/plausible_web/live/shared_link_settings_test.exs b/test/plausible_web/live/shared_link_settings_test.exs
index 39fb55d679..28d226bcd5 100644
--- a/test/plausible_web/live/shared_link_settings_test.exs
+++ b/test/plausible_web/live/shared_link_settings_test.exs
@@ -117,6 +117,27 @@ defmodule PlausibleWeb.Live.SharedLinkSettingsTest do
assert html =~ "Create your first shared link"
end
+
+ test "cannot edit shared link from another site by passing its slug as a param", %{
+ conn: conn,
+ site: site,
+ session: session
+ } do
+ _own_link = insert(:shared_link, site: site, name: "Own Link")
+ victim_site = insert(:site)
+ victim_link = insert(:shared_link, site: victim_site, name: "Victim Link")
+
+ lv = get_liveview(conn, session)
+
+ html = render_click(lv, "edit-shared-link", %{"slug" => victim_link.slug})
+
+ refute html =~ "Edit shared link"
+ assert html =~ "Could not find Shared Link"
+
+ # Verify the victim's shared link is unchanged in the database
+ reloaded = Plausible.Repo.reload!(victim_link)
+ assert reloaded.name == "Victim Link"
+ end
end
defp get_liveview(conn, session) do