Merge pull request #259 from getsentry/phoenix-endpoint-errors

Capture Phoenix.Endpoint errors

Author: mitchellhenke

README.md

@@ -38,13 +38,22 @@ For optional settings check the [docs](https://hexdocs.pm/sentry/readme.html).
 
 ### Setup with Plug or Phoenix
 
-In your router add the following lines:
+In your Plug.Router or Phoenix.Router, add the following lines:
 
 ```elixir
 use Plug.ErrorHandler
 use Sentry.Plug
 ```
 
+If you are using Phoenix, you can also include [Sentry.Phoenix.Endpoint](https://hexdocs.pm/sentry/Sentry.Phoenix.Endpoint.html) in your Endpoint. This module captures errors occurring in the Phoenix pipeline before the request reaches the Router:
+
+```elixir
+use Phoenix.Endpoint, otp_app: :my_app
+use Sentry.Phoenix.Endpoint
+```
+
+More information on why this may be necessary can be found here: https://github.com/getsentry/sentry-elixir/issues/229 and https://github.com/phoenixframework/phoenix/issues/2791
+
 ### Capture All Exceptions
 
 This library comes with an extension to capture all error messages that the Plug handler might not.  This is based on the Erlang [error_logger](http://erlang.org/doc/man/error_logger.html).

docs/index.rst

@@ -115,7 +115,7 @@ Filtering Events
 If you would like to prevent certain exceptions, the ``:filter`` configuration option
 allows you to implement the ``Sentry.EventFilter`` behaviour.  The first argument is the
 exception to be sent, and the second is the source of the event.  ``Sentry.Plug``
-will have a source of ``:plug``, and ``Sentry.Logger`` will have a source of ``:logger``.
+will have a source of ``:plug``, ``Sentry.Logger`` will have a source of ``:logger``, and ``Sentry.Phoenix.Endpoint`` will have a source of ``:endpoint``.
 If an exception does not come from either of those sources, the source will be nil
 unless the ``:event_source`` option is passed to ``Sentry.capture_exception/2``
 

lib/sentry.ex

@@ -54,7 +54,7 @@ defmodule Sentry do
   If you would like to prevent certain exceptions, the `:filter` configuration option
   allows you to implement the `Sentry.EventFilter` behaviour.  The first argument is the
   exception to be sent, and the second is the source of the event.  `Sentry.Plug`
-  will have a source of `:plug`, and `Sentry.Logger` will have a source of `:logger`.
+  will have a source of `:plug`, `Sentry.Logger` will have a source of `:logger`, and `Sentry.Phoenix.Endpoint` will have a source of `:endpoint`.
   If an exception does not come from either of those sources, the source will be nil
   unless the `:event_source` option is passed to `Sentry.capture_exception/2`
 

lib/sentry/event_filter.ex

@@ -1,7 +1,5 @@
 defmodule Sentry.EventFilter do
-  @moduledoc """
-
-  """
+  @moduledoc false
 
   @callback exclude_exception?(Exception.t(), atom) :: any
 end

lib/sentry/phoenix_endpoint.ex

@@ -0,0 +1,49 @@
+defmodule Sentry.Phoenix.Endpoint do
+  @moduledoc """
+  Provides basic functionality to handle errors in a Phoenix Endpoint. Errors occurring within a Phoenix request before it reaches the Router will not be captured by `Sentry.Plug` due to the internal functionality of Phoenix.
+
+  It is recommended to include `Sentry.Phoenix.Endpoint` in your Phoenix app if you would like to receive errors occurring in the previously mentioned circumstances.
+
+  For more information, see https://github.com/getsentry/sentry-elixir/issues/229 and https://github.com/phoenixframework/phoenix/issues/2791.
+
+
+  #### Usage
+
+  Add the following to your endpoint.ex, below `use Phoenix.Endpoint, otp_app: :my_app`
+
+        use Sentry.Phoenix.Endpoint
+
+  """
+  defmacro __using__(_opts) do
+    quote do
+      @before_compile Sentry.Phoenix.Endpoint
+    end
+  end
+
+  defmacro __before_compile__(_) do
+    quote do
+      defoverridable call: 2
+
+      def call(conn, opts) do
+        try do
+          super(conn, opts)
+        catch
+          kind, reason ->
+            stacktrace = System.stacktrace()
+            request = Sentry.Plug.build_request_interface_data(conn, [])
+            exception = Exception.normalize(kind, reason, stacktrace)
+
+            Sentry.capture_exception(
+              exception,
+              stacktrace: stacktrace,
+              request: request,
+              event_source: :endpoint,
+              error_type: kind
+            )
+
+            :erlang.raise(kind, reason, stacktrace)
+        end
+      end
+    end
+  end
+end

lib/sentry/plug.ex

@@ -148,9 +148,14 @@ if Code.ensure_loaded?(Plug) do
 
     @spec build_request_interface_data(Plug.Conn.t(), keyword()) :: map()
     def build_request_interface_data(%Plug.Conn{} = conn, opts) do
-      body_scrubber = Keyword.get(opts, :body_scrubber)
-      header_scrubber = Keyword.get(opts, :header_scrubber)
-      cookie_scrubber = Keyword.get(opts, :cookie_scrubber)
+      body_scrubber = Keyword.get(opts, :body_scrubber, {__MODULE__, :default_body_scrubber})
+
+      header_scrubber =
+        Keyword.get(opts, :header_scrubber, {__MODULE__, :default_header_scrubber})
+
+      cookie_scrubber =
+        Keyword.get(opts, :cookie_scrubber, {__MODULE__, :default_cookie_scrubber})
+
       request_id = Keyword.get(opts, :request_id_header) || @default_plug_request_id_header
 
       conn =

mix.exs

@@ -28,6 +28,7 @@ defmodule Sentry.Mixfile do
       {:uuid, "~> 1.0"},
       {:poison, "~> 1.5 or ~> 2.0 or ~> 3.0"},
       {:plug, "~> 1.0", optional: true},
+      {:phoenix, "~> 1.3", optional: true},
       {:dialyxir, "> 0.0.0", only: [:dev], runtime: false},
       {:ex_doc, "~> 0.18.0", only: :dev},
       {:credo, "~> 0.8", only: [:dev, :test], runtime: false},

mix.lock

@@ -1,23 +1,26 @@
 %{
   "bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], [], "hexpm"},
   "bypass": {:hex, :bypass, "0.8.1", "16d409e05530ece4a72fabcf021a3e5c7e15dcc77f911423196a0c551f2a15ca", [:mix], [{:cowboy, "~> 1.0", [hex: :cowboy, repo: "hexpm", optional: false]}, {:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: false]}], "hexpm"},
-  "certifi": {:hex, :certifi, "1.2.1", "c3904f192bd5284e5b13f20db3ceac9626e14eeacfbb492e19583cf0e37b22be", [:rebar3], [], "hexpm"},
+  "certifi": {:hex, :certifi, "2.3.1", "d0f424232390bf47d82da8478022301c561cf6445b5b5fb6a84d49a9e76d2639", [:rebar3], [{:parse_trans, "3.2.0", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm"},
   "cowboy": {:hex, :cowboy, "1.1.2", "61ac29ea970389a88eca5a65601460162d370a70018afe6f949a29dca91f3bb0", [:rebar3], [{:cowlib, "~> 1.0.2", [hex: :cowlib, repo: "hexpm", optional: false]}, {:ranch, "~> 1.3.2", [hex: :ranch, repo: "hexpm", optional: false]}], "hexpm"},
   "cowlib": {:hex, :cowlib, "1.0.2", "9d769a1d062c9c3ac753096f868ca121e2730b9a377de23dec0f7e08b1df84ee", [:make], [], "hexpm"},
-  "credo": {:hex, :credo, "0.8.10", "261862bb7363247762e1063713bb85df2bbd84af8d8610d1272cd9c1943bba63", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}], "hexpm"},
+  "credo": {:hex, :credo, "0.9.0", "5d1b494e4f2dc672b8318e027bd833dda69be71eaac6eedd994678be74ef7cb4", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:poison, ">= 0.0.0", [hex: :poison, repo: "hexpm", optional: false]}], "hexpm"},
   "dialyxir": {:hex, :dialyxir, "0.5.1", "b331b091720fd93e878137add264bac4f644e1ddae07a70bf7062c7862c4b952", [:mix], [], "hexpm"},
   "earmark": {:hex, :earmark, "1.2.4", "99b637c62a4d65a20a9fb674b8cffb8baa771c04605a80c911c4418c69b75439", [:mix], [], "hexpm"},
   "ex_doc": {:hex, :ex_doc, "0.18.3", "f4b0e4a2ec6f333dccf761838a4b253d75e11f714b85ae271c9ae361367897b7", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"},
-  "hackney": {:hex, :hackney, "1.8.6", "21a725db3569b3fb11a6af17d5c5f654052ce9624219f1317e8639183de4a423", [:rebar3], [{:certifi, "1.2.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.0.2", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"},
-  "idna": {:hex, :idna, "5.0.2", "ac203208ada855d95dc591a764b6e87259cb0e2a364218f215ad662daa8cd6b4", [:rebar3], [{:unicode_util_compat, "0.2.0", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm"},
+  "hackney": {:hex, :hackney, "1.12.1", "8bf2d0e11e722e533903fe126e14d6e7e94d9b7983ced595b75f532e04b7fdc7", [:rebar3], [{:certifi, "2.3.1", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.1.1", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"},
+  "idna": {:hex, :idna, "5.1.1", "cbc3b2fa1645113267cc59c760bafa64b2ea0334635ef06dbac8801e42f7279c", [:rebar3], [{:unicode_util_compat, "0.3.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm"},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm"},
   "mime": {:hex, :mime, "1.2.0", "78adaa84832b3680de06f88f0997e3ead3b451a440d183d688085be2d709b534", [:mix], [], "hexpm"},
   "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], [], "hexpm"},
-  "plug": {:hex, :plug, "1.4.3", "236d77ce7bf3e3a2668dc0d32a9b6f1f9b1f05361019946aae49874904be4aed", [:mix], [{:cowboy, "~> 1.0.1 or ~> 1.1", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm"},
+  "parse_trans": {:hex, :parse_trans, "3.2.0", "2adfa4daf80c14dc36f522cf190eb5c4ee3e28008fc6394397c16f62a26258c2", [:rebar3], [], "hexpm"},
+  "phoenix": {:hex, :phoenix, "1.3.2", "2a00d751f51670ea6bc3f2ba4e6eb27ecb8a2c71e7978d9cd3e5de5ccf7378bd", [:mix], [{:cowboy, "~> 1.0", [hex: :cowboy, repo: "hexpm", optional: true]}, {:phoenix_pubsub, "~> 1.0", [hex: :phoenix_pubsub, repo: "hexpm", optional: false]}, {:plug, "~> 1.3.3 or ~> 1.4", [hex: :plug, repo: "hexpm", optional: false]}, {:poison, "~> 2.2 or ~> 3.0", [hex: :poison, repo: "hexpm", optional: false]}], "hexpm"},
+  "phoenix_pubsub": {:hex, :phoenix_pubsub, "1.0.2", "bfa7fd52788b5eaa09cb51ff9fcad1d9edfeb68251add458523f839392f034c1", [:mix], [], "hexpm"},
+  "plug": {:hex, :plug, "1.5.0", "224b25b4039bedc1eac149fb52ed456770b9678bbf0349cdd810460e1e09195b", [:mix], [{:cowboy, "~> 1.0.1 or ~> 1.1 or ~> 2.1", [hex: :cowboy, repo: "hexpm", optional: true]}, {:mime, "~> 1.0", [hex: :mime, repo: "hexpm", optional: false]}], "hexpm"},
   "poison": {:hex, :poison, "3.1.0", "d9eb636610e096f86f25d9a46f35a9facac35609a7591b3be3326e99a0484665", [:mix], [], "hexpm"},
   "ranch": {:hex, :ranch, "1.3.2", "e4965a144dc9fbe70e5c077c65e73c57165416a901bd02ea899cfd95aa890986", [:rebar3], [], "hexpm"},
   "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [:make, :rebar], [], "hexpm"},
   "ssl_verify_hostname": {:hex, :ssl_verify_hostname, "1.0.5", "2e73e068cd6393526f9fa6d399353d7c9477d6886ba005f323b592d389fb47be", [:make], []},
-  "unicode_util_compat": {:hex, :unicode_util_compat, "0.2.0", "dbbccf6781821b1c0701845eaf966c9b6d83d7c3bfc65ca2b78b88b8678bfa35", [:rebar3], [], "hexpm"},
+  "unicode_util_compat": {:hex, :unicode_util_compat, "0.3.1", "a1f612a7b512638634a603c8f401892afbf99b8ce93a45041f8aaca99cadb85e", [:rebar3], [], "hexpm"},
   "uuid": {:hex, :uuid, "1.1.8", "e22fc04499de0de3ed1116b770c7737779f226ceefa0badb3592e64d5cfb4eb9", [:mix], [], "hexpm"},
 }

test/event_test.exs

@@ -1,5 +1,5 @@
 defmodule Sentry.EventTest do
-  use ExUnit.Case, async: true
+  use ExUnit.Case
   alias Sentry.Event
   import Sentry.TestEnvironmentHelper
 
@@ -448,22 +448,25 @@ defmodule Sentry.EventTest do
     event = Sentry.Event.transform_exception(exception, [])
 
     assert event.modules == %{
+             phoenix: "1.3.2",
+             phoenix_pubsub: "1.0.2",
              bunt: "0.2.0",
              bypass: "0.8.1",
-             certifi: "1.2.1",
+             certifi: "2.3.1",
              cowboy: "1.1.2",
              cowlib: "1.0.2",
-             credo: "0.8.10",
-             hackney: "1.8.6",
-             idna: "5.0.2",
+             credo: "0.9.0",
+             hackney: "1.12.1",
+             idna: "5.1.1",
              metrics: "1.0.1",
              mime: "1.2.0",
              mimerl: "1.0.2",
-             plug: "1.4.3",
+             parse_trans: "3.2.0",
+             plug: "1.5.0",
              poison: "3.1.0",
              ranch: "1.3.2",
              ssl_verify_fun: "1.1.1",
-             unicode_util_compat: "0.2.0",
+             unicode_util_compat: "0.3.1",
              uuid: "1.1.8"
            }
   end

test/phoenix_endpoint_test.exs

@@ -0,0 +1,43 @@
+defmodule Sentry.PhoenixEndpointTest do
+  use ExUnit.Case
+  use Plug.Test
+  import Sentry.TestEnvironmentHelper
+
+  Application.put_env(
+    :sentry,
+    __MODULE__.Endpoint,
+    render_errors: [view: Sentry.ErrorView, accepts: ~w(html)]
+  )
+
+  defmodule Endpoint do
+    use Phoenix.Endpoint, otp_app: :sentry
+    use Sentry.Phoenix.Endpoint
+    plug(:error)
+    plug(Sentry.ExampleApp)
+
+    def error(_conn, _opts) do
+      raise "EndpointError"
+    end
+  end
+
+  test "reports errors occurring in Phoenix Endpoint" do
+    bypass = Bypass.open()
+
+    Bypass.expect(bypass, fn conn ->
+      {:ok, body, conn} = Plug.Conn.read_body(conn)
+      json = Poison.decode!(body)
+      assert json["culprit"] == "Sentry.PhoenixEndpointTest.Endpoint.error/2"
+      assert json["message"] == "(RuntimeError) EndpointError"
+      Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
+    end)
+
+    modify_env(:sentry, dsn: "http://public:secret@localhost:#{bypass.port}/1")
+    modify_env(:phoenix, format_encoders: [])
+    {:ok, _} = Endpoint.start_link()
+
+    assert_raise RuntimeError, "EndpointError", fn ->
+      conn(:get, "/")
+      |> Endpoint.call([])
+    end
+  end
+end