diff --git a/extra/lib/plausible_web/controllers/api/external_sites_controller.ex b/extra/lib/plausible_web/controllers/api/external_sites_controller.ex index a7c044df4..78da9e0dd 100644 --- a/extra/lib/plausible_web/controllers/api/external_sites_controller.ex +++ b/extra/lib/plausible_web/controllers/api/external_sites_controller.ex @@ -1,7 +1,7 @@ defmodule PlausibleWeb.Api.ExternalSitesController do use PlausibleWeb, :controller use Plausible.Repo - use Plug.ErrorHandler + use PlausibleWeb.Plugs.ErrorHandler alias Plausible.Sites alias Plausible.Goals alias PlausibleWeb.Api.Helpers, as: H @@ -161,8 +161,4 @@ defmodule PlausibleWeb.Api.ExternalSitesController do error_msg = Atom.to_string(field) <> ": " <> msg %{"error" => error_msg} end - - def handle_errors(conn, %{kind: kind, reason: reason}) do - json(conn, %{error: Exception.format_banner(kind, reason)}) - end end diff --git a/lib/plausible_web/controllers/api/external_stats_controller.ex b/lib/plausible_web/controllers/api/external_stats_controller.ex index 939828b51..3f19f0c6c 100644 --- a/lib/plausible_web/controllers/api/external_stats_controller.ex +++ b/lib/plausible_web/controllers/api/external_stats_controller.ex @@ -1,7 +1,7 @@ defmodule PlausibleWeb.Api.ExternalStatsController do use PlausibleWeb, :controller use Plausible.Repo - use Plug.ErrorHandler + use PlausibleWeb.Plugs.ErrorHandler alias Plausible.Stats.{Query, CustomProps} def realtime_visitors(conn, _params) do @@ -190,10 +190,6 @@ defmodule PlausibleWeb.Api.ExternalStatsController do end end - def handle_errors(conn, %{kind: kind, reason: reason}) do - json(conn, %{error: Exception.format_banner(kind, reason)}) - end - defp percent_change(old_count, new_count) do cond do old_count == 0 and new_count > 0 -> diff --git a/lib/plausible_web/controllers/api/stats_controller.ex b/lib/plausible_web/controllers/api/stats_controller.ex index cccb5f253..d1aa45ff6 100644 --- a/lib/plausible_web/controllers/api/stats_controller.ex +++ b/lib/plausible_web/controllers/api/stats_controller.ex @@ -2,7 +2,7 @@ defmodule PlausibleWeb.Api.StatsController do use Plausible use PlausibleWeb, :controller use Plausible.Repo - use Plug.ErrorHandler + use PlausibleWeb.Plugs.ErrorHandler alias Plausible.Stats alias Plausible.Stats.{Query, Filters, Comparisons} alias PlausibleWeb.Api.Helpers, as: H @@ -1276,10 +1276,6 @@ defmodule PlausibleWeb.Api.StatsController do defp google_api(), do: Application.fetch_env!(:plausible, :google_api) - def handle_errors(conn, %{kind: kind, reason: reason}) do - json(conn, %{error: Exception.format_banner(kind, reason)}) - end - def filter_suggestions(conn, params) do site = conn.assigns[:site] diff --git a/lib/plausible_web/plugs/error_handler.ex b/lib/plausible_web/plugs/error_handler.ex new file mode 100644 index 000000000..9eab40e49 --- /dev/null +++ b/lib/plausible_web/plugs/error_handler.ex @@ -0,0 +1,22 @@ +defmodule PlausibleWeb.Plugs.ErrorHandler do + @moduledoc """ + A thin macro wrapper around Plug.ErrorHandler that adds Sentry context + containing a readable support hash presented to the users. + To be used in the user-facing APIs, so that we don't leak internal + server errors. + + Usage: `use PlausibleWeb.Plugs.ErrorHandler` + """ + defmacro __using__(_) do + quote do + use Plug.ErrorHandler + + @impl Plug.ErrorHandler + def handle_errors(conn, %{kind: kind, reason: reason}) do + hash = Hahash.name({kind, reason}) + Sentry.Context.set_extra_context(%{hash: hash}) + json(conn, %{error: "internal server error", support_hash: hash}) + end + end + end +end