Merge pull request #385 from getsentry/feedback

mitchellhenke · web-flow · commit 6767cecae630 · 2020-02-14T15:50:03.000-06:00
allow gathering feedback for sentry errors
diff --git a/lib/sentry/plug.ex b/lib/sentry/plug.ex
@@ -97,6 +97,16 @@ if Code.ensure_loaded?(Plug) do
     which Plug.RequestId (and therefore Phoenix) also default to.
 
         use Sentry.Plug, request_id_header: "application-request-id"
+
+    ### Collect User Feedback after Error
+
+    Sentry allows collecting user feedback after they hit an error.
+    Information about it is available [here](https://docs.sentry.io/enriching-error-data/user-feedback).
+    If a Plug request experiences an error that Sentry is reporting, and the request
+    accepts the content-type "text/html" or "*/*", the feedback form will be rendered.
+    The configuration is limited to the defaults at the moment, but it can be enabled with:
+
+        use Sentry.Plug, collect_feedback: [enabled: true]
     """
 
     @default_plug_request_id_header "x-request-id"
@@ -108,6 +118,8 @@ if Code.ensure_loaded?(Plug) do
       cookie_scrubber = Keyword.get(env, :cookie_scrubber, {__MODULE__, :default_cookie_scrubber})
 
       request_id_header = Keyword.get(env, :request_id_header)
+      collect_feedback = Keyword.get(env, :collect_feedback, [])
+      collect_feedback_enabled = Keyword.get(collect_feedback, :enabled, false)
 
       quote do
         # Ignore 404s for Plug routes
@@ -130,18 +142,63 @@ if Code.ensure_loaded?(Plug) do
             request_id_header: unquote(request_id_header)
           ]
 
+          collect_feedback_enabled = unquote(collect_feedback_enabled)
           request = Sentry.Plug.build_request_interface_data(conn, opts)
           exception = Exception.normalize(kind, reason, stack)
 
-          Sentry.capture_exception(
-            exception,
-            stacktrace: stack,
-            request: request,
-            event_source: :plug,
-            error_type: kind
-          )
+          accept_html =
+            Plug.Conn.get_req_header(conn, "accept")
+            |> Enum.any?(fn header ->
+              String.split(header, ",")
+              |> Enum.any?(&(&1 == "text/html" || &1 == "*/*"))
+            end)
+
+          if accept_html && collect_feedback_enabled do
+            result =
+              Sentry.capture_exception(
+                exception,
+                stacktrace: stack,
+                request: request,
+                event_source: :plug,
+                error_type: kind,
+                result: :sync
+              )
+
+            render_sentry_feedback(conn, result)
+          else
+            Sentry.capture_exception(
+              exception,
+              stacktrace: stack,
+              request: request,
+              event_source: :plug,
+              error_type: kind
+            )
+          end
         end
 
+        defp render_sentry_feedback(conn, {:ok, id}) do
+          html = """
+            <!DOCTYPE HTML>
+            <html lang="en">
+              <head>
+                <meta charset="utf-8">
+                <script src="https://browser.sentry-cdn.com/5.9.1/bundle.min.js" integrity="sha384-/x1aHz0nKRd6zVUazsV6CbQvjJvr6zQL2CHbQZf3yoLkezyEtZUpqUNnOLW9Nt3v" crossorigin="anonymous"></script>
+                <script>
+                  Sentry.init({ dsn: '#{Sentry.Config.dsn()}' });
+                  Sentry.showReportDialog({ eventId: '#{id}' })
+                </script>
+              </head>
+              <body>
+              </body>
+            </html>
+          """
+
+          Plug.Conn.put_resp_header(conn, "content-type", "text/html")
+          |> Plug.Conn.send_resp(conn.status, html)
+        end
+
+        defp render_sentry_feedback(_conn, _result), do: nil
+
         defoverridable handle_errors: 2
       end
     end
diff --git a/test/plug_test.exs b/test/plug_test.exs
@@ -162,6 +162,41 @@ defmodule Sentry.PlugTest do
     end)
   end
 
+  test "collects feedback" do
+    Code.compile_string("""
+      defmodule CollectFeedbackApp do
+        use Plug.Router
+        use Plug.ErrorHandler
+        use Sentry.Plug, collect_feedback: [enabled: true]
+        plug :match
+        plug :dispatch
+        forward("/", to: Sentry.ExampleApp)
+      end
+    """)
+
+    bypass = Bypass.open()
+
+    Bypass.expect(bypass, fn conn ->
+      {:ok, _body, _conn} = Plug.Conn.read_body(conn)
+      Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
+    end)
+
+    modify_env(:sentry, dsn: "http://public:secret@localhost:#{bypass.port}/1")
+
+    conn =
+      conn(:get, "/error_route")
+      |> Plug.Conn.put_req_header("accept", "text/html")
+
+    assert_raise(Plug.Conn.WrapperError, "** (RuntimeError) Error", fn ->
+      CollectFeedbackApp.call(conn, [])
+    end)
+
+    assert_received {:plug_conn, :sent}
+    assert {500, _headers, body} = sent_resp(conn)
+    assert body =~ "340"
+    assert body =~ "sentry-cdn"
+  end
+
   defp update_req_cookie(conn, name, value) do
     req_headers =
       conn.req_headers
