Exposes get_dsn! function

Author: rafaeljesus

lib/mix/tasks/sentry.send_test_event.ex

@@ -5,11 +5,7 @@ defmodule Mix.Tasks.Sentry.SendTestEvent do
 
   def run(_args) do
     Application.ensure_all_started(:sentry)
-    {endpoint, public_key, secret_key} = case Application.fetch_env(:sentry, :dsn) do
-      {:ok, dsn} when is_binary(dsn) -> Sentry.Client.parse_dsn!(dsn)
-      _ ->
-        Mix.raise "Sentry DSN is not configured in :sentry, :dsn"
-    end
+    {endpoint, public_key, secret_key} = Sentry.Client.get_dsn!
 
     included_environments = case Application.fetch_env(:sentry, :included_environments) do
       {:ok, envs} when is_list(envs) -> envs
@@ -30,11 +26,15 @@ defmodule Mix.Tasks.Sentry.SendTestEvent do
     maybe_send_event(environment_name, included_environments)
   end
 
-  def maybe_send_event(env_name, included_envs) do
+  defp maybe_send_event(env_name, included_envs) do
     if env_name in included_envs do
       Mix.shell.info "Sending test event..."
-      Sentry.capture_exception(RuntimeError.exception("Testing sending Sentry event"))
-      |> Task.await()
+
+      "Testing sending Sentry event"
+      |> RuntimeError.exception
+      |> Sentry.capture_exception
+      |> Task.await
+
       Mix.shell.info "Test event sent!"
     else
       Mix.shell.info "#{inspect env_name} is not in #{inspect included_envs} so no test event will be sent"

lib/sentry/client.ex

@@ -1,7 +1,7 @@
 defmodule Sentry.Client do
   alias Sentry.{Event, Util}
   require Logger
-  @type parsed_dsn :: {String.t, String.t, Integer.t}
+  @type get_dsn :: {String.t, String.t, Integer.t}
   @sentry_version 5
   @max_attempts 4
 
@@ -21,7 +21,7 @@ defmodule Sentry.Client do
   """
   @spec send_event(%Event{}) :: {:ok, String.t} | :error
   def send_event(%Event{} = event) do
-    {endpoint, public_key, secret_key} = dsn_env |> parse_dsn!
+    {endpoint, public_key, secret_key} = get_dsn!
 
     auth_headers = authorization_headers(public_key, secret_key)
     body = Poison.encode!(event)
@@ -31,13 +31,6 @@ defmodule Sentry.Client do
     end)
   end
 
-  def dsn_env do
-    case Application.fetch_env!(:sentry, :dsn) do
-      {:system, env_var} -> System.get_env(env_var)
-      value -> value
-    end
-  end
-
   defp try_request(method, url, headers, body) do
     do_try_request(method, url, headers, body, 1)
   end
@@ -101,12 +94,12 @@ defmodule Sentry.Client do
   end
 
   @doc """
-  Parses a Sentry DSN which is simply a URI.
+  Get a Sentry DSN which is simply a URI.
   """
-  @spec parse_dsn!(String.t) :: parsed_dsn
-  def parse_dsn!(dsn) do
+  @spec get_dsn! :: get_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(dsn)
+    %URI{userinfo: userinfo, host: host, port: port, path: path, scheme: protocol} = URI.parse(fetch_dsn)
     [public_key, secret_key] = String.split(userinfo, ":", parts: 2)
     [_, binary_project_id] = String.split(path, "/")
     project_id = String.to_integer(binary_project_id)
@@ -115,6 +108,13 @@ defmodule Sentry.Client do
     {endpoint, public_key, secret_key}
   end
 
+  defp fetch_dsn do
+    case Application.fetch_env!(:sentry, :dsn) do
+      {:system, env_var} -> System.get_env(env_var)
+      value -> value
+    end
+  end
+
   defp log_api_error(body) do
     Logger.warn(fn ->
       ["Failed to send sentry event.", ?\n, body]

test/client_test.exs

@@ -5,28 +5,25 @@ defmodule Sentry.ClientTest do
   alias Sentry.Client
   @sentry_dsn "https://public:[email protected]/1"
 
-  test "authorization" do
-    {_endpoint, public_key, private_key} = Client.parse_dsn!("https://public:[email protected]/1")
-    assert Client.authorization_header(public_key, private_key) =~ ~r/Sentry sentry_version=5, sentry_client=sentry-elixir\/#{Application.spec(:sentry, :vsn)}, sentry_timestamp=\d{10}, sentry_key=public, sentry_secret=secret/
+  setup do
+    Application.put_env(:sentry, :dsn, @sentry_dsn)
   end
 
-  test "parsing dsn" do
-    assert {"https://app.getsentry.com:443/api/1/store/", "public", "secret"} =
-      Sentry.Client.parse_dsn!("https://public:[email protected]/1")
-
-    assert {"http://app.getsentry.com:9000/api/1/store/", "public", "secret"} =
-      Sentry.Client.parse_dsn!("http://public:[email protected]:9000/1")
+  test "authorization" do
+    {_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\/#{Application.spec(:sentry, :vsn)}, sentry_timestamp=\d{10}, sentry_key=public, sentry_secret=secret/
   end
 
-  test "fetches default dsn_env" do
-    Application.put_env(:sentry, :dsn, @sentry_dsn)
-    assert @sentry_dsn == Sentry.Client.dsn_env
+  test "get dsn with default config" do
+    assert {"https://app.getsentry.com:443/api/1/store/", "public", "secret"} = Sentry.Client.get_dsn!
   end
 
-  test "fetches system dsn_env" do
+  test "get dsn with system config" do
     System.put_env("SYSTEM_KEY", @sentry_dsn)
     Application.put_env(:sentry, :dsn, {:system, "SYSTEM_KEY"})
-    assert @sentry_dsn == Sentry.Client.dsn_env
+    assert {"https://app.getsentry.com:443/api/1/store/", "public", "secret"} = Sentry.Client.get_dsn!
+
+    System.delete_env("SYSTEM_KEY")
   end
 
   test "logs api errors" do
@@ -35,7 +32,8 @@ defmodule Sentry.ClientTest do
       {:ok, _body, conn} = Plug.Conn.read_body(conn)
       assert conn.request_path == "/api/1/store/"
       assert conn.method == "POST"
-      Plug.Conn.put_resp_header(conn, "X-Sentry-Error", "Creation of this event was denied due to rate limiting.")
+      conn
+      |> Plug.Conn.put_resp_header("X-Sentry-Error", "Creation of this event was denied due to rate limiting.")
       |> Plug.Conn.resp(400, "Something bad happened")
     end
 

test/support/test_client.ex

@@ -1,6 +1,6 @@
 defmodule Sentry.TestClient do
   def send_event(%Sentry.Event{} = event) do
-    {endpoint, _public_key, _secret_key} = Sentry.Client.parse_dsn!(Application.fetch_env!(:sentry, :dsn))
+    {endpoint, _public_key, _secret_key} = Sentry.Client.get_dsn!
     body = Poison.encode!(event)
     Sentry.Client.request(:post, endpoint, [], body)
   end