Skip to content

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

Better error message on site creation error (#2644)

Adam Rutkowski482249ffbae0
diff --git a/lib/plausible_web/controllers/api/external_sites_controller.ex b/lib/plausible_web/controllers/api/external_sites_controller.ex
index 57e18e0b97..cbb1eac57d 100644
--- a/lib/plausible_web/controllers/api/external_sites_controller.ex
+++ b/lib/plausible_web/controllers/api/external_sites_controller.ex
@@ -13,11 +13,6 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
{:ok, %{site: site}} ->
json(conn, site)
- {:error, :site, changeset, _} ->
- conn
- |> put_status(400)
- |> json(serialize_errors(changeset))
-
{:error, :limit, limit, _} ->
conn
|> put_status(403)
@@ -25,6 +20,11 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
error:
"Your account has reached the limit of #{limit} sites per account. Please contact [email protected] to unlock more sites."
})
+
+ {:error, _, changeset, _} ->
+ conn
+ |> put_status(400)
+ |> json(serialize_errors(changeset))
end
end
@@ -139,7 +139,7 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
defp serialize_errors(changeset) do
{field, {msg, _opts}} = List.first(changeset.errors)
- error_msg = Atom.to_string(field) <> " " <> msg
+ error_msg = Atom.to_string(field) <> ": " <> msg
%{"error" => error_msg}
end
diff --git a/test/plausible_web/controllers/api/external_sites_controller_test.exs b/test/plausible_web/controllers/api/external_sites_controller_test.exs
index 9706ca5c5e..01ba959e55 100644
--- a/test/plausible_web/controllers/api/external_sites_controller_test.exs
+++ b/test/plausible_web/controllers/api/external_sites_controller_test.exs
@@ -39,7 +39,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
conn = post(conn, "/api/v1/sites", %{})
assert json_response(conn, 400) == %{
- "error" => "domain can't be blank"
+ "error" => "domain: can't be blank"
}
end
@@ -57,7 +57,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
conn = post(conn, "/api/v1/sites", %{"domain" => bad_domain})
assert %{"error" => error} = json_response(conn, 400)
- assert error =~ "domain must not contain URI reserved characters"
+ assert error =~ "domain: must not contain URI reserved characters"
end)
end
@@ -79,6 +79,29 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
}
end
+ test "does not allow creating a site when external events are present", %{
+ conn: conn
+ } do
+ domain = "events-exist.example.com"
+
+ populate_stats(%{domain: domain}, [
+ build(:pageview)
+ ])
+
+ :inserted = eventually(fn -> {Plausible.Sites.has_events?(domain), :inserted} end)
+
+ conn =
+ post(conn, "/api/v1/sites", %{
+ "domain" => domain,
+ "timezone" => "Europe/Tallinn"
+ })
+
+ assert json_response(conn, 400) == %{
+ "error" =>
+ "domain: This domain has already been taken. Perhaps one of your team members registered it? If that's not the case, please contact [email protected]"
+ }
+ end
+
test "cannot access with a bad API key scope", %{conn: conn, user: user} do
api_key = insert(:api_key, user: user, scopes: ["stats:read:*"])