convert list type to list

Author: mitchellhenke

lib/sentry/config.ex

@@ -1,6 +1,8 @@
 defmodule Sentry.Config do
   @moduledoc """
   This module provides the functionality for fetching configuration settings and their defaults.
+
+  Sentry supports loading config at runtime, via `{:system, SYSTEM_ENV_KEY}` tuples, where Sentry will read `SYSTEM_ENV_KEY` to get the config value from the system environment at runtime.
   """
 
   @default_included_environments [:dev, :test, :prod]
@@ -19,8 +21,11 @@ defmodule Sentry.Config do
     get_config(:dsn, check_dsn: false)
   end
 
+  @doc """
+  The `:included_environments` config key expects a list, but if given a string, it will split the string on commas to create a list.
+  """
   def included_environments do
-    get_config(:included_environments, default: @default_included_environments, check_dsn: false)
+    get_config(:included_environments, default: @default_included_environments, check_dsn: false, type: :list)
   end
 
   def environment_name do
@@ -108,6 +113,7 @@ defmodule Sentry.Config do
   defp get_config(key, opts \\ []) when is_atom(key) do
     default = Keyword.get(opts, :default)
     check_dsn = Keyword.get(opts, :check_dsn, true)
+    type = Keyword.get(opts, :type)
 
     environment_result = case get_from_application_environment(key) do
       {:ok, value} -> {:ok, value}
@@ -120,11 +126,15 @@ defmodule Sentry.Config do
     end
 
     case result do
-      {:ok, value} -> value
+      {:ok, value} -> convert_type(value, type)
       :not_found -> default
     end
   end
 
+  defp convert_type(value, nil), do: value
+  defp convert_type(value, :list) when is_list(value), do: value
+  defp convert_type(value, :list) when is_binary(value), do: String.split(value, ",")
+
   defp get_from_application_environment(key) when is_atom(key) do
     case Application.fetch_env(:sentry, key) do
       {:ok, {:system, env_var}} -> get_from_system_environment(env_var)

test/config_test.exs

@@ -37,4 +37,17 @@ defmodule Sentry.ConfigTest do
       refute "test" == Config.source_code_path_pattern()
     end
   end
+
+  describe "included_environments" do
+    test "retrieves and converts string from system environment" do
+      delete_env(:sentry, [:included_environments])
+      modify_system_env(%{"SENTRY_INCLUDED_ENVIRONMENTS" => "test,dev"})
+      assert ["test", "dev"] == Config.included_environments()
+    end
+
+    test "retrieves and converts string from config" do
+      modify_env(:sentry, included_environments: "test,dev")
+      assert ["test", "dev"] == Config.included_environments()
+    end
+  end
 end

test/support/test_environment_helper.exs

@@ -14,6 +14,21 @@ defmodule Sentry.TestEnvironmentHelper do
     end)
   end
 
+  def delete_env(app, deletes) do
+    original_env = Application.get_all_env(app)
+    Enum.each(deletes, fn key -> Application.delete_env(app, key) end)
+
+    ExUnit.Callbacks.on_exit(fn ->
+      Enum.each deletes, fn key ->
+        if Keyword.has_key?(original_env, key) do
+          Application.put_env(app, key, Keyword.fetch!(original_env, key))
+        else
+          Application.delete_env(app, key)
+        end
+      end
+    end)
+  end
+
   def modify_system_env(overrides) when is_map(overrides) do
     original_env = System.get_env()
     System.put_env(overrides)