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
Refactor goals API
Uku Taht97cdc4814e4a
diff --git a/lib/plausible/goal/schema.ex b/lib/plausible/goal/schema.exindex 51fb5c38b7..0c84b9941a 100644--- a/lib/plausible/goal/schema.ex+++ b/lib/plausible/goal/schema.ex@@ -2,7 +2,7 @@ defmodule Plausible.Goal douse Ecto.Schemaimport Ecto.Changeset- @derive {Jason.Encoder, only: [:domain, :event_name, :page_path]}+ @derive {Jason.Encoder, only: [:id, :domain, :event_name, :page_path]}schema "goals" dofield :domain, :stringfield :event_name, :stringdiff --git a/lib/plausible/goals.ex b/lib/plausible/goals.exindex 202ee815dc..af3a7d5cf0 100644--- a/lib/plausible/goals.ex+++ b/lib/plausible/goals.ex@@ -8,6 +8,28 @@ defmodule Plausible.Goals doGoal.changeset(%Goal{}, params) |> Repo.insert()end+ def find_or_create(site, %{"goal_type" => "event", "event_name" => event_name}) do+ goal = Repo.get_by(Plausible.Goal, domain: site.domain, event_name: event_name)++ case goal do+ nil -> create(site, %{"event_name" => event_name})+ goal -> {:ok, goal}+ end+ end++ def find_or_create(_, %{"goal_type" => "event"}), do: {:missing, "event_name"}++ def find_or_create(site, %{"goal_type" => "page", "page_path" => page_path}) do+ goal = Repo.get_by(Plausible.Goal, domain: site.domain, page_path: page_path)++ case goal do+ nil -> create(site, %{"page_path" => page_path})+ goal -> {:ok, goal}+ end+ end++ def find_or_create(_, %{"goal_type" => "page"}), do: {:missing, "page_path"}+def for_site(domain) doRepo.all(from g in Goal,diff --git a/lib/plausible_web/controllers/api/external_sites_controller.ex b/lib/plausible_web/controllers/api/external_sites_controller.exindex d15fdaaa7c..299195ca86 100644--- a/lib/plausible_web/controllers/api/external_sites_controller.ex+++ b/lib/plausible_web/controllers/api/external_sites_controller.ex@@ -83,91 +83,17 @@ defmodule PlausibleWeb.Api.ExternalSitesController dodef find_or_create_goal(conn, params) dowith {:ok, site_id} <- expect_param_key(params, "site_id"),- {:ok, goal_type} <- expect_param_key(params, "goal_type"),+ {:ok, _} <- expect_param_key(params, "goal_type"),site when not is_nil(site) <-- Sites.get_for_user(conn.assigns[:current_user].id, site_id, [:owner, :admin]) do- case goal_type do- "event" ->- with {:ok, event_name} <- expect_param_key(params, "event_name") do- goal = Repo.get_by(Plausible.Goal, domain: site_id, event_name: event_name)-- goal =- case goal do- nil -> Goals.create(site, %{"event_name" => event_name})- goal -> {:ok, goal}- end-- case goal do- {:ok, goal} ->- json(conn, %{- domain: site_id,- goal_id: goal.id,- goal_type: goal_type,- event_name: goal.event_name- })-- nil ->- H.not_found(conn, "Goal could not be found")- end- else- nil ->- H.not_found(conn, "Goal could not be found")-- {:missing, "event_name"} ->- H.bad_request(conn, "Parameter `event_name` is required to create a goal")-- e ->- H.bad_request(conn, "Something went wrong: #{inspect(e)}")- end-- "page" ->- with {:ok, page_path} <- expect_param_key(params, "page_path") do- goal = Repo.get_by(Plausible.Goal, domain: site_id, page_path: page_path)-- goal =- case goal do- nil -> Goals.create(site, %{"page_path" => page_path})- goal -> {:ok, goal}- end-- case goal do- {:ok, goal} ->- json(conn, %{- domain: site_id,- goal_id: goal.id,- goal_type: goal_type,- page_path: goal.page_path- })-- nil ->- H.not_found(conn, "Goal could not be found")- end- else- nil ->- H.not_found(conn, "Goal could not be found")-- {:missing, "page_path"} ->- H.bad_request(conn, "Parameter `page_path` is required to create a goal")-- e ->- H.bad_request(conn, "Something went wrong: #{inspect(e)}")- end-- _ ->- H.not_found(conn, "Invalid goal type")- end+ Sites.get_for_user(conn.assigns[:current_user].id, site_id, [:owner, :admin]),+ {:ok, goal} <- Goals.find_or_create(site, params) do+ json(conn, goal)elsenil ->H.not_found(conn, "Site could not be found")- {:missing, "site_id"} ->- H.bad_request(conn, "Parameter `site_id` is required to create a goal")-- {:missing, "goal_type"} ->- H.bad_request(conn, "Parameter `goal_type` is required to create a goal")-- {:missing, "goal_value"} ->- H.bad_request(conn, "Parameter `goal_value` is required to create a goal")+ {:missing, param} ->+ H.bad_request(conn, "Parameter `#{param}` is required to create a goal")e ->H.bad_request(conn, "Something went wrong: #{inspect(e)}")@@ -178,7 +104,7 @@ defmodule PlausibleWeb.Api.ExternalSitesController dowith {:ok, site_id} <- expect_param_key(params, "site_id"),{:ok, goal_id} <- expect_param_key(params, "goal_id"),site when not is_nil(site) <-- Sites.get_for_user(conn.assigns[:current_user].id, site_id, [:owner]) do+ Sites.get_for_user(conn.assigns[:current_user].id, site_id, [:owner, :admin]) dogoal = Repo.get_by(Plausible.Goal, id: goal_id)if goal dodiff --git a/test/plausible_web/controllers/api/external_sites_controller_test.exs b/test/plausible_web/controllers/api/external_sites_controller_test.exsindex 54762c8405..c45982ea3b 100644--- a/test/plausible_web/controllers/api/external_sites_controller_test.exs+++ b/test/plausible_web/controllers/api/external_sites_controller_test.exs@@ -227,7 +227,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest doevent_name: "Signup"})- %{"goal_id" => goal_id} = json_response(conn, 200)+ %{"id" => goal_id} = json_response(conn, 200)conn =put(conn, "/api/v1/sites/goals", %{@@ -236,7 +236,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest doevent_name: "Signup"})- assert %{"goal_id" => ^goal_id} = json_response(conn, 200)+ assert %{"id" => ^goal_id} = json_response(conn, 200)endtest "returns 400 when site id missing", %{conn: conn} do@@ -330,7 +330,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest doevent_name: "Signup"})- %{"goal_id" => goal_id} = json_response(conn, 200)+ %{"id" => goal_id} = json_response(conn, 200)conn =delete(conn, "/api/v1/sites/goals/#{goal_id}", %{@@ -354,7 +354,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest douser: user} dosite = insert(:site, members: [])- insert(:site_membership, user: user, site: site, role: :admin)+ insert(:site_membership, user: user, site: site, role: :viewer)conn =delete(conn, "/api/v1/sites/goals/1", %{