Really fix those flaky tests

Author: whatyouhide

lib/sentry/application.ex

@@ -25,7 +25,7 @@ defmodule Sentry.Application do
         [Sentry.Transport.SenderPool]
 
     cache_loaded_applications()
-    Sources.load_source_code_map_if_present()
+    _ = Sources.load_source_code_map_if_present()
 
     Supervisor.start_link(children, strategy: :one_for_one, name: Sentry.Supervisor)
   end

lib/sentry/config.ex

@@ -1,9 +1,6 @@
 defmodule Sentry.Config do
   @moduledoc false
 
-  @default_exclude_patterns [~r"/_build/", ~r"/deps/", ~r"/priv/", ~r"/test/"]
-  @private_env_keys [:sender_pool_size]
-
   basic_opts_schema = [
     dsn: [
       type: {:or, [:string, nil]},
@@ -232,7 +229,7 @@ defmodule Sentry.Config do
       type:
         {:list,
          {:custom, __MODULE__, :__validate_struct__, [:source_code_exclude_patterns, Regex]}},
-      default: @default_exclude_patterns,
+      default: [~r"/_build/", ~r"/deps/", ~r"/priv/", ~r"/test/"],
       type_doc: "list of `t:Regex.t/0`",
       doc: """
       A list of regular expressions used to determine which files to
@@ -309,7 +306,6 @@ defmodule Sentry.Config do
   def validate!(config) when is_list(config) do
     config_opts =
       config
-      |> Keyword.drop(@private_env_keys)
       |> Keyword.take(@valid_keys)
       |> fill_in_from_env(:dsn, "SENTRY_DSN")
       |> fill_in_from_env(:release, "SENTRY_RELEASE")
@@ -325,7 +321,8 @@ defmodule Sentry.Config do
 
       {:error, error} ->
         raise ArgumentError, """
-        invalid configuration for the :sentry application, so we cannot start it. The error was:
+        invalid configuration for the :sentry application, so we cannot start or update
+        its configuration. The error was:
 
             #{Exception.message(error)}
 
@@ -336,11 +333,9 @@ defmodule Sentry.Config do
 
   @spec persist(keyword()) :: :ok
   def persist(config) when is_list(config) do
-    for {key, value} <- config do
+    Enum.each(config, fn {key, value} ->
       :persistent_term.put({:sentry_config, key}, value)
-    end
-
-    :ok
+    end)
   end
 
   @spec docs() :: String.t()
@@ -370,10 +365,6 @@ defmodule Sentry.Config do
     """
   end
 
-  # Also exposed as a function to be used in docs in the Sentry module.
-  @spec default_source_code_exclude_patterns() :: [Regex.t(), ...]
-  def default_source_code_exclude_patterns, do: @default_exclude_patterns
-
   @spec dsn() :: String.t() | nil
   def dsn, do: get(:dsn)
 
@@ -460,27 +451,20 @@ defmodule Sentry.Config do
 
   @spec put_config(atom(), term()) :: :ok
   def put_config(key, value) when is_atom(key) do
-    case NimbleOptions.validate([{key, value}], @opts_schema) do
-      {:ok, options} ->
-        renamed_key =
-          case key do
-            :before_send_event -> :before_send
-            other -> other
-          end
-
-        options
-        |> handle_deprecated_before_send()
-        |> Keyword.take([renamed_key])
-        |> persist()
-
-      {:error, error} ->
-        raise ArgumentError, """
-        invalid configuration to update. The error was:
+    unless key in @valid_keys do
+      raise ArgumentError, "unknown option #{inspect(key)}"
+    end
 
-            #{Exception.message(error)}
+    renamed_key =
+      case key do
+        :before_send_event -> :before_send
+        other -> other
+      end
 
-        """
-    end
+    [{key, value}]
+    |> validate!()
+    |> Keyword.take([renamed_key])
+    |> persist()
   end
 
   ## Helpers

lib/sentry/sources.ex

@@ -11,31 +11,34 @@ defmodule Sentry.Sources do
 
   @source_code_map_key {:sentry, :source_code_map}
 
-  @spec load_source_code_map_if_present() :: :ok
+  @spec load_source_code_map_if_present() :: :loaded | {:error, term()}
   def load_source_code_map_if_present do
     path = Path.relative_to_cwd(path_of_packaged_source_code())
 
     with {:ok, contents} <- File.read(path),
          {:ok, source_map} <- decode_source_code_map(contents) do
       :persistent_term.put(@source_code_map_key, source_map)
+      {:loaded, source_map}
     else
       {:error, :binary_to_term} ->
         IO.warn("""
         Sentry found a source code map file at #{path}, but it was unable to decode its
         contents.
         """)
 
+        {:error, :decoding_error}
+
       {:error, :enoent} ->
-        :ok
+        {:error, :enoent}
 
       {:error, reason} ->
         IO.warn("""
         Sentry found a source code map file at #{path}, but it was unable to read it.
         The reason was: #{:file.format_error(reason)}
         """)
-    end
 
-    :ok
+        {:error, reason}
+    end
   end
 
   @spec path_of_packaged_source_code() :: Path.t()
@@ -65,8 +68,9 @@ defmodule Sentry.Sources do
     :persistent_term.get(@source_code_map_key, nil)
   end
 
-  @spec load_files([Path.t()]) :: {:ok, source_map()} | {:error, message :: String.t()}
-  def load_files(root_paths \\ Config.root_source_code_paths()) when is_list(root_paths) do
+  @spec load_files([Path.t()] | nil) :: {:ok, source_map()} | {:error, message :: String.t()}
+  def load_files(root_paths \\ nil) do
+    root_paths = root_paths || Config.root_source_code_paths()
     path_pattern = Config.source_code_path_pattern()
     exclude_patterns = Config.source_code_exclude_patterns()
 

mix.exs

@@ -57,7 +57,8 @@ defmodule Sentry.Mixfile do
         ],
         authors: ["Mitchell Henke", "Jason Stiebs", "Andrea Leopardi"]
       ],
-      xref: [exclude: [:hackney, :hackney_pool, Plug.Conn]]
+      xref: [exclude: [:hackney, :hackney_pool, Plug.Conn]],
+      aliases: [aliases()]
     ]
   end
 
@@ -107,4 +108,8 @@ defmodule Sentry.Mixfile do
       }
     ]
   end
+
+  defp aliases do
+    [test: ["sentry.package_source_code", "test"]]
+  end
 end

test/context_test.exs

@@ -1,5 +1,5 @@
 defmodule Sentry.ContextTest do
-  use ExUnit.Case, async: false
+  use Sentry.Case, async: false
 
   import Sentry.TestHelpers
 

test/envelope_test.exs

@@ -1,5 +1,5 @@
 defmodule Sentry.EnvelopeTest do
-  use ExUnit.Case, async: false
+  use Sentry.Case, async: false
 
   import Sentry.TestHelpers
 

test/event_test.exs

@@ -1,5 +1,5 @@
 defmodule Sentry.EventTest do
-  use ExUnit.Case, async: false
+  use Sentry.Case, async: false
 
   import Sentry.TestHelpers
 

test/logger_backend_test.exs

@@ -1,5 +1,5 @@
 defmodule Sentry.LoggerBackendTest do
-  use ExUnit.Case, async: false
+  use Sentry.Case, async: false
 
   import Sentry.TestHelpers
 

test/mix/sentry.package_source_code_test.exs

@@ -1,5 +1,5 @@
 defmodule Mix.Tasks.Sentry.PackageSourceCodeTest do
-  use ExUnit.Case, async: false
+  use Sentry.Case, async: false
 
   import Sentry.TestHelpers
 

test/mix/sentry.send_test_event_test.exs

@@ -1,5 +1,5 @@
 defmodule Mix.Tasks.Sentry.SendTestEventTest do
-  use ExUnit.Case
+  use Sentry.Case
 
   import ExUnit.CaptureIO
   import Sentry.TestHelpers