make environment_name easier to work with

Author: mitchellhenke

README.md

@@ -71,7 +71,7 @@ config :sentry,
 | Key           | Required         | Default      | Notes |
 | ------------- | -----------------|--------------|-------|
 | `dsn` | True  | n/a | |
-| `environment_name` | False  | `MIX_ENV` | |
+| `environment_name` | False  | `:dev` | |
 | `included_environments` | False  | `~w(prod test dev)a` | If you need non-standard mix env names you *need* to include it here |
 | `tags` | False  | `%{}` | |
 | `release` | False  | None | |

config/config.exs

@@ -1,6 +1,8 @@
 use Mix.Config
 
 config :sentry,
-  included_environments: [:prod]
+  included_environments: [:test, :dev, :prod],
+  environment_name: :dev,
+  tags: %{}
 
 import_config "#{Mix.env}.exs"

docs/config.rst

@@ -22,7 +22,7 @@ Required settings
 
 .. describe:: environment_name
 
-  The name of the environment, this defaults to the ``MIX_ENV`` environment variable.
+  The name of the environment, this defaults to the ``:dev`` environment variable.
 
 .. describe:: dsn
 

lib/sentry.ex

@@ -34,7 +34,6 @@ defmodule Sentry do
   @use_error_logger Application.get_env(:sentry, :use_error_logger, false)
 
   def start(_type, _opts) do
-    check_required_env!()
     children = []
     opts = [strategy: :one_for_one, name: Sentry.Supervisor]
 
@@ -66,27 +65,13 @@ defmodule Sentry do
   end
 
   def send_event(event = %Event{}) do
-    included_environments = Application.get_env(:sentry, :included_environments, ~w(prod dev test)a)
+    included_environments = Application.get_env(:sentry, :included_environments)
+    environment_name = Application.get_env(:sentry, :environment_name)
 
-    if event.environment in included_environments do
+    if environment_name in included_environments do
       @client.send_event(event)
     else
       {:ok, ""}
     end
   end
-
-  defp check_required_env! do
-    case Application.fetch_env(:sentry, :environment_name) do
-      {:ok, env} -> env
-      :error ->
-        case System.get_env("MIX_ENV") do
-          nil ->
-            raise RuntimeError.exception("environment_name not configured")
-          system_env ->
-            env = String.to_atom(system_env)
-            Application.put_env(:sentry, :environment_name, env)
-            env
-        end
-    end
-  end
 end

test/logger_test.exs

@@ -1,5 +1,5 @@
 defmodule Sentry.LoggerTest do
-  use ExUnit.Case, async: true
+  use ExUnit.Case
   import ExUnit.CaptureLog
 
   test "exception makes call to Sentry API" do

test/sentry_test.exs

@@ -1,11 +1,3 @@
 defmodule SentryTest do
   use ExUnit.Case, async: true
-  test "fails with RuntimeError without environment_name configured" do
-    assert_raise RuntimeError, fn ->
-      Application.delete_env(:sentry, :environment_name)
-      Sentry.start(nil, nil)
-    end
-
-    Application.put_env(:sentry, :environment_name, :test)
-  end
 end