Revert default :included_environments to [:prod]

Author: whatyouhide

CHANGELOG.md

@@ -12,14 +12,14 @@
 - Removed `Sentry.Event.do_put_source_context/3`
 - Removed the `:async` value for the `:result` option in `Sentry.send_event/2` (and friends)
 - Removed `Sentry.CrashError` — now, crash reports (detected through `Sentry.LoggerBackend`) that do not contain exceptions are reported as *messages* in Sentry
-- Started accepting all environments by default by changing the default for the `:included_environments` configuration option from `[:prod]` to `:all`
 - Changed the shape of the `Sentry.Event` struct - check out the new fields (and typespec for `Sentry.Event.t/0`)
 
 ### Improvements
 
 - Add `Sentry.LoggerHandler`, which is a `:logger` handler rather than a `Logger` backend
 - Make the `Sentry.HTTPClient.child_spec/0` callback optional
 - Add `:all` as a possible value of the `:metadata` configuration option for `Sentry.LoggerBackend`
+- Add `:all` as a possible value for the `:included_environment` configuration option
 - Add `Sentry.Interfaces` with all the child modules, which are useful if you're working directly with the Sentry API
 
 ### Deprecations

lib/sentry.ex

@@ -35,7 +35,7 @@ defmodule Sentry do
   configuration file:
 
       config :sentry, dsn: "https://public:[email protected]/1",
-        included_environments: ["prod"],
+        included_environments: [:prod],
         environment_name: config_env()
 
   This will set the environment name to whatever the current environment

lib/sentry/config.ex

@@ -110,7 +110,18 @@ defmodule Sentry.Config do
   end
 
   def included_environments do
-    Application.get_env(:sentry, :included_environments, :all)
+    case Application.fetch_env(:sentry, :included_environments) do
+      {:ok, :all} ->
+        :all
+
+      {:ok, envs} when is_list(envs) ->
+        string_envs = Enum.map(envs, &to_string/1)
+        Application.put_env(:sentry, :included_environments, string_envs)
+        string_envs
+
+      :error ->
+        _default = ["prod"]
+    end
   end
 
   def environment_name do

pages/upgrade-9.x.md

@@ -98,16 +98,6 @@ The settings that are now *compile-time settings* are:
   * `:source_code_path_pattern`
   * `:source_code_exclude_patterns`
 
-## Check Your Use of `:included_environments`
-
-If you were relying on the default value for the `:included_environments` configuration option (which was `[:prod]`), then you'll need to make an adjustment. In v9.0.0, the default value is now `:all` (see [this issue](https://github.com/getsentry/sentry-elixir/issues/483) for some context). If you want to keep the old behavior, explicitly set this in your configuration:
-
-```elixir
-# In config/config.exs
-config :sentry,
-  included_environments: [:prod]
-```
-
 ## Stop Using `Sentry.Sources`
 
 `Sentry.Sources` was meant to be private API and has been removed. Its functionality is very specific to Sentry, and it's not a good general mechanism to retrieve source code. This way, we can also have the freedom to improve this functionality without making potential breaking changes to the API of this library.

test/config_test.exs

@@ -33,7 +33,7 @@ defmodule Sentry.ConfigTest do
   describe "included_environments" do
     test "retrieves from app env" do
       modify_env(:sentry, included_environments: [:test, :dev])
-      assert [:test, :dev] == Config.included_environments()
+      assert ["test", "dev"] == Config.included_environments()
     end
   end