Skip to content

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

Better error message change domain (#6462)

Adam Rutkowski8a0d359aec1b
diff --git a/lib/plausible_web/live/change_domain/form.ex b/lib/plausible_web/live/change_domain/form.ex
index 45e1e95696..231b62901d 100644
--- a/lib/plausible_web/live/change_domain/form.ex
+++ b/lib/plausible_web/live/change_domain/form.ex
@@ -4,12 +4,18 @@ defmodule PlausibleWeb.Live.ChangeDomain.Form do
"""
use PlausibleWeb, :live_component
- alias Plausible.Site
+ alias Plausible.{Repo, Site}
+
+ import Ecto.Query
def update(assigns, socket) do
changeset = Site.update_changeset(assigns.site)
- {:ok, assign(socket, Map.put(assigns, :changeset, changeset))}
+ {:ok,
+ socket
+ |> assign(assigns)
+ |> assign(changeset: changeset)
+ |> assign(already_owned_domain: nil)}
end
def render(assigns) do
@@ -24,6 +30,16 @@ defmodule PlausibleWeb.Live.ChangeDomain.Form do
label="Domain"
/>
+ <p
+ :if={@already_owned_domain}
+ class="mt-1 flex text-sm text-red-500 leading-4.5 text-pretty"
+ >
+ You already own this site. See its&nbsp;
+ <.styled_link href={Routes.site_path(@socket, :settings_general, @already_owned_domain)}>
+ settings
+ </.styled_link>
+ </p>
+
<.button type="submit" class="mt-4 w-full">
Change Domain
</.button>
@@ -33,13 +49,30 @@ defmodule PlausibleWeb.Live.ChangeDomain.Form do
end
def handle_event("submit", %{"site" => %{"domain" => new_domain}}, socket) do
- case Plausible.Site.Domain.change(socket.assigns.site, new_domain) do
- {:ok, updated_site} ->
- send(self(), {:domain_changed, updated_site})
- {:noreply, socket}
+ site = socket.assigns.site
+ preview_changeset = Site.update_changeset(site, %{domain: new_domain})
+ cleaned_domain = Ecto.Changeset.get_field(preview_changeset, :domain)
+
+ if same_team_owns_domain?(site, cleaned_domain) do
+ {:noreply,
+ assign(socket, changeset: preview_changeset, already_owned_domain: cleaned_domain)}
+ else
+ case Plausible.Site.Domain.change(site, new_domain) do
+ {:ok, updated_site} ->
+ send(self(), {:domain_changed, updated_site})
+ {:noreply, assign(socket, already_owned_domain: nil)}
- {:error, changeset} ->
- {:noreply, assign(socket, changeset: changeset)}
+ {:error, changeset} ->
+ {:noreply, assign(socket, changeset: changeset, already_owned_domain: nil)}
+ end
end
end
+
+ defp same_team_owns_domain?(%Site{id: site_id, team_id: team_id}, domain) do
+ Repo.exists?(
+ from s in Site, where: s.domain == ^domain and s.team_id == ^team_id and s.id != ^site_id
+ )
+ end
+
+ defp same_team_owns_domain?(_, _), do: false
end
diff --git a/test/plausible/site/domain_test.exs b/test/plausible/site/domain_test.exs
index 15a629337d..98a0135738 100644
--- a/test/plausible/site/domain_test.exs
+++ b/test/plausible/site/domain_test.exs
@@ -49,6 +49,32 @@ defmodule Plausible.Site.DomainTest do
assert {:ok, _} = Domain.change(Repo.reload!(site1), "bar.example.com")
end
+ test "domain swap is allowed between sites in the same team" do
+ team = insert(:team)
+ site1 = insert(:site, domain: "one.example.com", team: team)
+ site2 = insert(:site, domain: "two.example.com", team: team)
+
+ assert {:ok, _} = Domain.change(site1, "tmp-one.example.com")
+
+ # site1's old domain "one.example.com" is now in domain_changed_from,
+ # but site2 is on the same team so swapping is allowed
+ assert {:ok, updated} = Domain.change(Repo.reload!(site2), "one.example.com")
+ assert updated.domain == "one.example.com"
+ end
+
+ test "domain swap is blocked between sites in different teams" do
+ team1 = insert(:team)
+ team2 = insert(:team)
+ site1 = insert(:site, domain: "one.example.com", team: team1)
+ site2 = insert(:site, domain: "two.example.com", team: team2)
+
+ assert {:ok, _} = Domain.change(site1, "tmp-one.example.com")
+
+ assert {:error, changeset} = Domain.change(Repo.reload!(site2), "one.example.com")
+ assert {error_message, _} = changeset.errors[:domain]
+ assert error_message =~ "This domain cannot be registered"
+ end
+
test "change info is cleared when the grace period expires" do
site = insert(:site)
diff --git a/test/plausible_web/live/change_domain_test.exs b/test/plausible_web/live/change_domain_test.exs
index df5b7428c7..3e50e48403 100644
--- a/test/plausible_web/live/change_domain_test.exs
+++ b/test/plausible_web/live/change_domain_test.exs
@@ -66,6 +66,28 @@ defmodule PlausibleWeb.Live.ChangeDomainTest do
assert is_nil(site.domain_changed_from)
end
+ test "form submission to a domain already owned by the same team shows a targeted error",
+ %{conn: conn, site: site, user: user} do
+ owned_site = new_site(owner: user)
+ {:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain")
+
+ html =
+ lv
+ |> element("form")
+ |> render_submit(%{site: %{domain: owned_site.domain}})
+
+ assert html =~ "You already own this site"
+
+ expected_settings_link =
+ Routes.site_path(conn, :settings_general, owned_site.domain)
+
+ assert html =~ expected_settings_link
+
+ site = Repo.reload!(site)
+ assert site.domain != owned_site.domain
+ assert is_nil(site.domain_changed_from)
+ end
+
test "form submission to a domain in transition period", %{conn: conn, site: site} do
_another_site = insert(:site, domain_changed_from: "foo.example.com")
{:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain")
@@ -82,6 +104,42 @@ defmodule PlausibleWeb.Live.ChangeDomainTest do
assert is_nil(site.domain_changed_from)
end
+ test "domain swap is allowed when both sites belong to the same team",
+ %{conn: conn, site: site, user: user} do
+ other_site = new_site(owner: user)
+
+ {:ok, lv, _html} = live(conn, "/#{site.domain}/change-domain")
+
+ new_domain = "tmp.#{site.domain}"
+
+ lv
+ |> element("form")
+ |> render_submit(%{site: %{domain: new_domain}})
+
+ on_ee do
+ render_async(lv, 500)
+ end
+
+ assert_patch(lv, "/#{URI.encode_www_form(new_domain)}/change-domain/success")
+
+ # Now swap: rename other_site to the original domain of site
+ original_domain = site.domain
+ other_original_domain = other_site.domain
+ {:ok, lv2, _html} = live(conn, "/#{other_original_domain}/change-domain")
+
+ lv2
+ |> element("form")
+ |> render_submit(%{site: %{domain: original_domain}})
+
+ on_ee do
+ render_async(lv2, 500)
+ end
+
+ assert_patch(lv2, "/#{URI.encode_www_form(original_domain)}/change-domain/success")
+
+ assert Repo.reload!(other_site).domain == original_domain
+ end
+
for {role, membership_type} <- [
{:editor, :site_guest},
{:editor, :team_member},