Merge Plugins.API.Router into main one

In order to get grafana metrics reported
See: akoutmos/prom_ex#224

lib/plausible_web.ex

@@ -62,8 +62,7 @@ defmodule PlausibleWeb do
     quote do
       use Phoenix.Controller, namespace: PlausibleWeb.Plugins.API
       import Plug.Conn
-      import PlausibleWeb.Plugins.API.Router.Helpers
-      import PlausibleWeb.Plugins.API, only: [base_uri: 0]
+      import PlausibleWeb.Router.Helpers
 
       alias PlausibleWeb.Plugins.API.Schemas
       alias PlausibleWeb.Plugins.API.Views
@@ -82,7 +81,7 @@ defmodule PlausibleWeb do
         namespace: PlausibleWeb.Plugins.API,
         root: ""
 
-      alias PlausibleWeb.Plugins.API.Router.Helpers
+      alias PlausibleWeb.Router.Helpers
       import PlausibleWeb.Plugins.API.Views.Pagination, only: [render_metadata_links: 4]
     end
   end

lib/plausible_web/plugins/api/controllers/goals.ex

@@ -31,7 +31,8 @@ defmodule PlausibleWeb.Plugins.API.Controllers.Goals do
 
     case API.Goals.create(site, goal_or_goals) do
       {:ok, goals} ->
-        location_headers = Enum.map(goals, &{"location", goals_url(base_uri(), :get, &1.id)})
+        location_headers =
+          Enum.map(goals, &{"location", plugins_api_goals_url(conn, :get, &1.id)})
 
         conn
         |> prepend_resp_headers(location_headers)

lib/plausible_web/plugins/api/controllers/shared_links.ex

@@ -66,7 +66,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.SharedLinks do
     conn
     |> put_view(Views.SharedLink)
     |> put_status(:created)
-    |> put_resp_header("location", shared_links_url(base_uri(), :get, shared_link.id))
+    |> put_resp_header("location", plugins_api_shared_links_url(conn, :get, shared_link.id))
     |> render("shared_link.json", shared_link: shared_link, authorized_site: site)
   end
 

lib/plausible_web/plugins/api/spec.ex

@@ -3,7 +3,7 @@ defmodule PlausibleWeb.Plugins.API.Spec do
   OpenAPI specification for the Plugins API
   """
   alias OpenApiSpex.{Components, Info, OpenApi, Paths, Server}
-  alias PlausibleWeb.Plugins.API.Router
+  alias PlausibleWeb.Router
   @behaviour OpenApi
 
   @impl OpenApi
@@ -12,7 +12,7 @@ defmodule PlausibleWeb.Plugins.API.Spec do
       servers: [
         %Server{
           description: "This server",
-          url: to_string(PlausibleWeb.Plugins.API.base_uri()),
+          url: PlausibleWeb.Endpoint.url(),
           variables: %{}
         }
       ],

lib/plausible_web/plugins/api/views/goal.ex

@@ -12,7 +12,7 @@ defmodule PlausibleWeb.Plugins.API.Views.Goal do
       }) do
     %{
       goals: render_many(goals, __MODULE__, "goal.json", authorized_site: site),
-      meta: render_metadata_links(metadata, :goals_url, :index, conn.query_params)
+      meta: render_metadata_links(metadata, :plugins_api_goals_url, :index, conn.query_params)
     }
   end
 
@@ -23,7 +23,7 @@ defmodule PlausibleWeb.Plugins.API.Views.Goal do
       }) do
     %{
       goals: render_many(goals, __MODULE__, "goal.json", authorized_site: site),
-      meta: render_metadata_links(%{}, :goals_url, :index, conn.query_params)
+      meta: render_metadata_links(%{}, :plugins_api_goals_url, :index, conn.query_params)
     }
   end
 

lib/plausible_web/plugins/api/views/pagination.ex

@@ -7,7 +7,7 @@ defmodule PlausibleWeb.Plugins.API.Views.Pagination do
     namespace: PlausibleWeb.Plugins.API,
     root: ""
 
-  alias PlausibleWeb.Plugins.API.Router.Helpers
+  alias PlausibleWeb.Router.Helpers
 
   def render_metadata_links(meta, helper_fn, helper_fn_args, existing_params \\ %{}) do
     render(__MODULE__, "pagination.json", %{
@@ -21,7 +21,7 @@ defmodule PlausibleWeb.Plugins.API.Views.Pagination do
           |> Map.merge(existing_params)
 
         args = [
-          PlausibleWeb.Plugins.API.base_uri()
+          PlausibleWeb.Endpoint
           | List.wrap(helper_fn_args) ++ [query_params]
         ]
 

lib/plausible_web/plugins/api/views/shared_link.ex

@@ -13,7 +13,7 @@ defmodule PlausibleWeb.Plugins.API.Views.SharedLink do
     %{
       shared_links:
         render_many(shared_links, __MODULE__, "shared_link.json", authorized_site: site),
-      meta: render_metadata_links(metadata, :shared_links_url, :index, conn.query_params)
+      meta: render_metadata_links(metadata, :plugins_api_shared_links_url, :index, conn.query_params)
     }
   end
 

lib/plausible_web/router.ex

@@ -86,8 +86,39 @@ defmodule PlausibleWeb.Router do
     end
   end
 
-  scope path: "/api/plugins" do
-    forward "/", PlausibleWeb.Plugins.API.Router
+  scope path: "/api/plugins", as: :plugins_api do
+    pipeline :plugins_api_auth do
+      plug(PlausibleWeb.Plugs.AuthorizePluginsAPI)
+    end
+
+    pipeline :plugins_api do
+      plug(:accepts, ["json"])
+      plug(OpenApiSpex.Plug.PutApiSpec, module: PlausibleWeb.Plugins.API.Spec)
+    end
+
+    scope "/spec" do
+      pipe_through(:plugins_api)
+      get("/openapi", OpenApiSpex.Plug.RenderSpec, [])
+      get("/swagger-ui", OpenApiSpex.Plug.SwaggerUI, path: "/api/plugins/spec/openapi")
+    end
+
+    scope "/v1", PlausibleWeb.Plugins.API.Controllers, assigns: %{plugins_api: true} do
+      pipe_through([:plugins_api, :plugins_api_auth])
+
+      get("/shared_links", SharedLinks, :index)
+      get("/shared_links/:id", SharedLinks, :get)
+      put("/shared_links", SharedLinks, :create)
+
+      get("/goals", Goals, :index)
+      get("/goals/:id", Goals, :get)
+      put("/goals", Goals, :create)
+
+      delete("/goals/:id", Goals, :delete)
+      delete("/goals", Goals, :delete_bulk)
+
+      put("/custom_props", CustomProps, :enable)
+      delete("/custom_props", CustomProps, :disable)
+    end
   end
 
   scope "/api/stats", PlausibleWeb.Api do

lib/plausible_web/views/error_view.ex

@@ -2,7 +2,7 @@ defmodule PlausibleWeb.ErrorView do
   use Plausible
   use PlausibleWeb, :view
 
-  def render("500.json", %{conn: %{private: %{PlausibleWeb.Plugins.API.Router => _}}}) do
+  def render("500.json", %{conn: %{assigns: %{plugins_api: true}}}) do
     contact_support_note =
       on_full_build do
         "If the problem persists please contact [email protected]"

test/plausible_web/plugins/api/controllers/custom_props_test.exs

@@ -22,8 +22,8 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CustomPropsTest do
 
   describe "unauthorized calls" do
     for {method, url} <- [
-          {:put, Routes.custom_props_url(base_uri(), :enable)},
-          {:delete, Routes.custom_props_url(base_uri(), :disable)}
+          {:put, Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :enable)},
+          {:delete, Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :disable)}
         ] do
       test "unauthorized call: #{method} #{url}", %{conn: conn} do
         conn
@@ -44,7 +44,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CustomPropsTest do
       site = Plausible.Repo.preload(site, :owner)
       insert(:growth_subscription, user: site.owner)
 
-      url = Routes.custom_props_url(base_uri(), :enable)
+      url = Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :enable)
 
       payload = %{
         custom_prop: %{key: "author"}
@@ -68,7 +68,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CustomPropsTest do
       site = Plausible.Repo.preload(site, :owner)
       insert(:growth_subscription, user: site.owner)
 
-      url = Routes.custom_props_url(base_uri(), :enable)
+      url = Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :enable)
 
       payload = %{
         custom_props: [
@@ -92,7 +92,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CustomPropsTest do
 
   describe "put /custom_prop - enable single prop" do
     test "validates input according to the schema", %{conn: conn, token: token, site: site} do
-      url = Routes.custom_props_url(base_uri(), :enable)
+      url = Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :enable)
 
       conn
       |> authenticate(site.domain, token)
@@ -103,7 +103,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CustomPropsTest do
     end
 
     test "enables single custom prop", %{conn: conn, token: token, site: site} do
-      url = Routes.custom_props_url(base_uri(), :enable)
+      url = Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :enable)
 
       payload = %{
         custom_prop: %{key: "author"}
@@ -130,7 +130,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CustomPropsTest do
     end
 
     test "is idempotent", %{conn: conn, token: token, site: site} do
-      url = Routes.custom_props_url(base_uri(), :enable)
+      url = Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :enable)
 
       initial_conn =
         conn
@@ -166,7 +166,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CustomPropsTest do
 
   describe "put /custom_props - bulk creation" do
     test "creates many custom props", %{conn: conn, token: token, site: site} do
-      url = Routes.custom_props_url(base_uri(), :enable)
+      url = Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :enable)
 
       payload = %{
         custom_props: [
@@ -209,7 +209,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CustomPropsTest do
     test "disable one prop", %{conn: conn, site: site, token: token} do
       {:ok, ["author"]} = Plausible.Plugins.API.CustomProps.enable(site, "author")
 
-      url = Routes.custom_props_url(base_uri(), :enable)
+      url = Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :enable)
 
       payload = %{custom_prop: %{key: "author"}}
 
@@ -226,7 +226,7 @@ defmodule PlausibleWeb.Plugins.API.Controllers.CustomPropsTest do
       {:ok, [_, _, _]} =
         Plausible.Plugins.API.CustomProps.enable(site, ["author", "category", "third"])
 
-      url = Routes.custom_props_url(base_uri(), :enable)
+      url = Routes.plugins_api_custom_props_url(PlausibleWeb.Endpoint, :enable)
 
       payload = %{
         custom_props: [