avoid raising on bad dsn

Author: mitchellhenke

lib/mix/tasks/sentry.send_test_event.ex

@@ -14,7 +14,7 @@ defmodule Mix.Tasks.Sentry.SendTestEvent do
 
     Application.ensure_all_started(:sentry)
 
-    Sentry.Client.get_dsn!()
+    Sentry.Client.get_dsn()
     |> print_environment_info()
 
     maybe_send_event()

lib/sentry/client.ex

@@ -38,8 +38,8 @@ defmodule Sentry.Client do
 
   require Logger
 
-  @type dsn :: {String.t(), String.t(), String.t()}
   @type send_event_result :: {:ok, Task.t() | String.t() | pid()} | :error | :unsampled
+  @type dsn :: {String.t(), String.t(), String.t()} | :error
   @sentry_version 5
   @max_attempts 4
   @hackney_pool_name :sentry_pool
@@ -85,34 +85,43 @@ defmodule Sentry.Client do
   end
 
   defp do_send_event(event, body, :async) do
-    {endpoint, public_key, secret_key} = get_dsn!()
-    auth_headers = authorization_headers(public_key, secret_key)
-
-    {:ok,
-     Task.Supervisor.async_nolink(Sentry.TaskSupervisor, fn ->
-       try_request(:post, endpoint, auth_headers, body)
-       |> maybe_call_after_send_event(event)
-     end)}
+    case get_headers_and_endpoint() do
+      {endpoint, auth_headers} ->
+        {:ok,
+         Task.Supervisor.async_nolink(Sentry.TaskSupervisor, fn ->
+           try_request(:post, endpoint, auth_headers, body)
+           |> maybe_call_after_send_event(event)
+         end)}
+
+      _ ->
+        :error
+    end
   end
 
   defp do_send_event(event, body, :sync) do
-    {endpoint, public_key, secret_key} = get_dsn!()
-    auth_headers = authorization_headers(public_key, secret_key)
+    case get_headers_and_endpoint() do
+      {endpoint, auth_headers} ->
+        try_request(:post, endpoint, auth_headers, body)
+        |> maybe_call_after_send_event(event)
 
-    try_request(:post, endpoint, auth_headers, body)
-    |> maybe_call_after_send_event(event)
+      _ ->
+        :error
+    end
   end
 
   defp do_send_event(event, body, :none) do
-    {endpoint, public_key, secret_key} = get_dsn!()
-    auth_headers = authorization_headers(public_key, secret_key)
+    case get_headers_and_endpoint() do
+      {endpoint, auth_headers} ->
+        Task.Supervisor.start_child(Sentry.TaskSupervisor, fn ->
+          try_request(:post, endpoint, auth_headers, body)
+          |> maybe_call_after_send_event(event)
+        end)
 
-    Task.Supervisor.start_child(Sentry.TaskSupervisor, fn ->
-      try_request(:post, endpoint, auth_headers, body)
-      |> maybe_call_after_send_event(event)
-    end)
+        {:ok, ""}
 
-    {:ok, ""}
+      _ ->
+        :error
+    end
   end
 
   defp try_request(method, url, headers, body, current_attempt \\ 1)
@@ -193,19 +202,25 @@ defmodule Sentry.Client do
 
   @doc """
   Get a Sentry DSN which is simply a URI.
+
+  {PROTOCOL}://{PUBLIC_KEY}:{SECRET_KEY}@{HOST}/{PATH}{PROJECT_ID}
   """
-  @spec get_dsn! :: dsn
-  def get_dsn! do
-    # {PROTOCOL}://{PUBLIC_KEY}:{SECRET_KEY}@{HOST}/{PATH}{PROJECT_ID}
-    %URI{userinfo: userinfo, host: host, port: port, path: path, scheme: protocol} =
-      URI.parse(Config.dsn())
-
-    [public_key, secret_key] = String.split(userinfo, ":", parts: 2)
-    [_, binary_project_id] = String.split(path, "/")
-    project_id = String.to_integer(binary_project_id)
-    endpoint = "#{protocol}://#{host}:#{port}/api/#{project_id}/store/"
-
-    {endpoint, public_key, secret_key}
+  @spec get_dsn :: dsn
+  def get_dsn do
+    dsn = Config.dsn()
+
+    with %URI{userinfo: userinfo, host: host, port: port, path: path, scheme: protocol}
+         when is_binary(path) <- URI.parse(dsn),
+         [public_key, secret_key] <- String.split(userinfo, ":", parts: 2),
+         [_, binary_project_id] <- String.split(path, "/"),
+         {project_id, ""} <- Integer.parse(binary_project_id),
+         endpoint <- "#{protocol}://#{host}:#{port}/api/#{project_id}/store/" do
+      {endpoint, public_key, secret_key}
+    else
+      _ ->
+        log_api_error("Cannot send event because of invalid DSN")
+        :error
+    end
   end
 
   @spec maybe_call_after_send_event(send_event_result, Event.t()) :: Event.t()
@@ -289,6 +304,16 @@ defmodule Sentry.Client do
     end
   end
 
+  defp get_headers_and_endpoint do
+    case get_dsn() do
+      {endpoint, public_key, secret_key} ->
+        {endpoint, authorization_headers(public_key, secret_key)}
+
+      _ ->
+        :error
+    end
+  end
+
   defp log_api_error(body) do
     Logger.warn(fn ->
       ["Failed to send Sentry event.", ?\n, body]

test/client_test.exs

@@ -8,7 +8,7 @@ defmodule Sentry.ClientTest do
 
   test "authorization" do
     modify_env(:sentry, dsn: "https://public:[email protected]/1")
-    {_endpoint, public_key, private_key} = Client.get_dsn!()
+    {_endpoint, public_key, private_key} = Client.get_dsn()
 
     assert Client.authorization_header(public_key, private_key) =~
              ~r/^Sentry sentry_version=5, sentry_client=sentry-elixir\/#{
@@ -20,15 +20,39 @@ defmodule Sentry.ClientTest do
     modify_env(:sentry, dsn: "https://public:[email protected]/1")
 
     assert {"https://app.getsentry.com:443/api/1/store/", "public", "secret"} =
-             Sentry.Client.get_dsn!()
+             Sentry.Client.get_dsn()
   end
 
   test "get dsn with system config" do
     modify_env(:sentry, dsn: {:system, "SYSTEM_KEY"})
     modify_system_env(%{"SYSTEM_KEY" => "https://public:[email protected]/1"})
 
     assert {"https://app.getsentry.com:443/api/1/store/", "public", "secret"} =
-             Sentry.Client.get_dsn!()
+             Sentry.Client.get_dsn()
+  end
+
+  test "errors on bad public/secret keys" do
+    modify_env(:sentry, dsn: "https://[email protected]/1")
+
+    capture_log(fn ->
+      assert :error = Sentry.Client.get_dsn()
+    end)
+  end
+
+  test "errors on non-integer project_id" do
+    modify_env(:sentry, dsn: "https://public:[email protected]/Mitchell")
+
+    capture_log(fn ->
+      assert :error = Sentry.Client.get_dsn()
+    end)
+  end
+
+  test "errors on no project_id" do
+    modify_env(:sentry, dsn: "https://public:[email protected]")
+
+    capture_log(fn ->
+      assert :error = Sentry.Client.get_dsn()
+    end)
   end
 
   test "logs api errors" do

test/support/test_client.exs

@@ -3,7 +3,7 @@ defmodule Sentry.TestClient do
   require Logger
 
   def send_event(%Sentry.Event{} = event, _opts \\ []) do
-    {endpoint, _public_key, _secret_key} = Sentry.Client.get_dsn!()
+    {endpoint, _public_key, _secret_key} = Sentry.Client.get_dsn()
     event = Sentry.Client.maybe_call_before_send_event(event)
 
     Sentry.Client.render_event(event)