Improve and speed up tests

Author: whatyouhide

config/config.exs

@@ -7,9 +7,10 @@ if config_env() == :test do
     enable_source_code_context: true,
     root_source_code_paths: [File.cwd!()],
     source_code_exclude_patterns: [],
-    hackney_opts: [recv_timeout: 50],
+    hackney_opts: [recv_timeout: 50, pool: :sentry_pool],
     send_result: :sync,
-    send_max_attempts: 1
+    send_max_attempts: 1,
+    dedup_events: false
 
   config :logger, backends: []
 end

lib/sentry/config.ex

@@ -462,7 +462,16 @@ defmodule Sentry.Config do
   def put_config(key, value) when is_atom(key) do
     case NimbleOptions.validate([{key, value}], @opts_schema) do
       {:ok, options} ->
-        options |> Keyword.take([key]) |> persist()
+        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, """

lib/sentry/dedupe.ex

@@ -10,9 +10,8 @@ defmodule Sentry.Dedupe do
   @ttl_millisec 30_000
 
   @spec start_link(keyword()) :: GenServer.on_start()
-  def start_link(opts) when is_list(opts) do
-    ttl_millisec = Keyword.get(opts, :ttl_millisec, @ttl_millisec)
-    GenServer.start_link(__MODULE__, ttl_millisec, name: __MODULE__)
+  def start_link([] = _opts) do
+    GenServer.start_link(__MODULE__, nil, name: __MODULE__)
   end
 
   @spec insert(Event.t()) :: :new | :existing
@@ -27,28 +26,31 @@ defmodule Sentry.Dedupe do
     end
   end
 
-  ## State
-  defstruct [:ttl_millisec]
-
   ## Callbacks
 
   @impl true
-  def init(ttl_millisec) do
+  def init(nil) do
     _table = :ets.new(@ets, [:named_table, :public, :set])
-    Process.send_after(self(), :sweep, @sweep_interval_millisec)
-    {:ok, %__MODULE__{ttl_millisec: ttl_millisec}}
+    schedule_sweep()
+    {:ok, :no_state}
   end
 
   @impl true
-  def handle_info(:sweep, %__MODULE__{} = state) do
+  def handle_info({:sweep, ttl_millisec}, state) do
     now = System.system_time(:millisecond)
 
     # All rows (which are {hash, inserted_at}) with an inserted_at older than
     # now - @ttl_millisec.
-    match_spec = [{{:"$1", :"$2"}, [], [{:<, :"$2", now - state.ttl_millisec}]}]
+    match_spec = [{{:"$1", :"$2"}, [], [{:<, :"$2", now - ttl_millisec}]}]
     _ = :ets.select_delete(@ets, match_spec)
 
-    Process.send_after(self(), :sweep, @sweep_interval_millisec)
+    schedule_sweep()
     {:noreply, state}
   end
+
+  ## Helpers
+
+  defp schedule_sweep do
+    Process.send_after(self(), {:sweep, @ttl_millisec}, @sweep_interval_millisec)
+  end
 end

test/context_test.exs

@@ -80,8 +80,7 @@ defmodule Sentry.ContextTest do
   @tag start_app: false
   test "passing in tags context as option overrides Context and Application config" do
     Context.set_tags_context(%{"key" => "345", "key1" => "123"})
-    modify_app_env(tags: %{"key" => "overridden", "key2" => "1234", "key3" => "12345"})
-
+    put_test_config(tags: %{"key" => "overridden", "key2" => "1234", "key3" => "12345"})
     event = Event.create_event(tags: %{"key" => "123"})
 
     assert event.tags == %{"key" => "123", "key1" => "123", "key2" => "1234", "key3" => "12345"}

test/envelope_test.exs

@@ -134,9 +134,9 @@ defmodule Sentry.EnvelopeTest do
 
   describe "to_binary/1" do
     test "encodes an envelope" do
-      modify_app_env(environment_name: "test")
-
+      put_test_config(environment_name: "test")
       event = Event.create_event([])
+
       envelope = Envelope.new([event])
 
       assert {:ok, encoded} = Envelope.to_binary(envelope)

test/event_test.exs

@@ -290,7 +290,7 @@ defmodule Sentry.EventTest do
   end
 
   test "sets :in_app to true when configured" do
-    modify_app_env(in_app_module_allow_list: [Sentry, :random, Sentry.Submodule])
+    put_test_config(in_app_module_allow_list: [Sentry, :random, Sentry.Submodule])
     exception = RuntimeError.exception("error")
 
     event =

test/logger_backend_test.exs

@@ -339,7 +339,7 @@ defmodule Sentry.LoggerBackendTest do
     pid = self()
     ref = make_ref()
 
-    modify_app_env(
+    put_test_config(
       before_send: fn event ->
         send(pid, {ref, event})
         false

test/mix/sentry.package_source_code_test.exs

@@ -1,13 +1,18 @@
 defmodule Mix.Tasks.Sentry.PackageSourceCodeTest do
   use ExUnit.Case, async: false
 
+  import Sentry.TestHelpers
+
   setup do
-    shell = Mix.shell()
-    Mix.shell(Mix.Shell.Process)
-    on_exit(fn -> Mix.shell(shell) end)
+    set_mix_shell(Mix.Shell.Process)
   end
 
   test "packages source code into :sentry's priv directory" do
+    put_test_config(
+      root_source_code_paths: [File.cwd!()],
+      enable_source_code_context: true
+    )
+
     expected_path =
       [Application.app_dir(:sentry), "priv", "sentry.map"]
       |> Path.join()

test/mix/sentry.send_test_event_test.exs

@@ -5,7 +5,7 @@ defmodule Mix.Tasks.Sentry.SendTestEventTest do
   import Sentry.TestHelpers
 
   test "prints if :dsn is not set" do
-    modify_app_env(dsn: nil)
+    put_test_config(dsn: nil, hackney_opts: [], environment_name: "some_env")
 
     output =
       capture_io(fn ->
@@ -14,8 +14,8 @@ defmodule Mix.Tasks.Sentry.SendTestEventTest do
 
     assert output =~ """
            Client configuration:
-           current environment_name: "test"
-           hackney_opts: [recv_timeout: 50]
+           current environment_name: "some_env"
+           hackney_opts: []
            """
 
     assert output =~ ~s(Event not sent because the :dsn option is not set)
@@ -32,7 +32,11 @@ defmodule Mix.Tasks.Sentry.SendTestEventTest do
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(dsn: "http://public:secret@localhost:#{bypass.port}/1")
+    put_test_config(
+      dsn: "http://public:secret@localhost:#{bypass.port}/1",
+      environment_name: "test",
+      hackney_opts: []
+    )
 
     output =
       capture_io(fn ->
@@ -45,7 +49,7 @@ defmodule Mix.Tasks.Sentry.SendTestEventTest do
            public_key: public
            secret_key: secret
            current environment_name: "test"
-           hackney_opts: [recv_timeout: 50]
+           hackney_opts: []
            """
 
     assert output =~ "Sending test event..."
@@ -62,10 +66,14 @@ defmodule Mix.Tasks.Sentry.SendTestEventTest do
       Plug.Conn.resp(conn, 500, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(
-      dsn: "http://public:secret@localhost:#{bypass.port}/1",
-      request_retries: []
-    )
+    original_retries =
+      Application.get_env(:sentry, :request_retries, Sentry.Transport.default_retries())
+
+    on_exit(fn -> Application.put_env(:sentry, :request_retries, original_retries) end)
+
+    Application.put_env(:sentry, :request_retries, [])
+
+    put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
     assert_raise Mix.Error, ~r/Error sending event/, fn ->
       capture_io(fn -> Mix.Tasks.Sentry.SendTestEvent.run([]) end)

test/plug_capture_test.exs

@@ -50,6 +50,14 @@ defmodule Sentry.PlugCaptureTest do
     end
   end
 
+  setup_all do
+    Application.put_env(:sentry, PhoenixEndpoint,
+      render_errors: [view: Sentry.ErrorView, accepts: ~w(html)]
+    )
+
+    :ok
+  end
+
   test "sends error to Sentry" do
     bypass = Bypass.open()
 
@@ -61,7 +69,7 @@ defmodule Sentry.PlugCaptureTest do
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(dsn: "http://public:secret@localhost:#{bypass.port}/1")
+    put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
     assert_raise(Plug.Conn.WrapperError, "** (RuntimeError) Error", fn ->
       conn(:get, "/error_route")
@@ -80,7 +88,7 @@ defmodule Sentry.PlugCaptureTest do
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(dsn: "http://public:secret@localhost:#{bypass.port}/1")
+    put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
     catch_throw(
       conn(:get, "/throw_route")
@@ -99,7 +107,7 @@ defmodule Sentry.PlugCaptureTest do
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(dsn: "http://public:secret@localhost:#{bypass.port}/1")
+    put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
     catch_exit(
       conn(:get, "/exit_route")
@@ -122,7 +130,7 @@ defmodule Sentry.PlugCaptureTest do
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(dsn: "http://public:secret@localhost:#{bypass.port}/1")
+    put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
     assert_raise(Plug.Conn.WrapperError, "** (RuntimeError) Error", fn ->
       conn(:get, "/error_route")
@@ -141,7 +149,7 @@ defmodule Sentry.PlugCaptureTest do
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(dsn: "http://public:secret@localhost:#{bypass.port}/1")
+    put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
     assert_raise(Plug.Conn.WrapperError, "** (RuntimeError) Error", fn ->
       conn(:get, "/error_route")
@@ -175,12 +183,7 @@ defmodule Sentry.PlugCaptureTest do
         Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
       end)
 
-      modify_app_env(
-        dsn: "http://public:secret@localhost:#{bypass.port}/1",
-        "#{__MODULE__.PhoenixEndpoint}": [
-          render_errors: [view: Sentry.ErrorView, accepts: ~w(html)]
-        ]
-      )
+      put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
       {:ok, _} = PhoenixEndpoint.start_link()
 
@@ -205,12 +208,7 @@ defmodule Sentry.PlugCaptureTest do
         Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
       end)
 
-      modify_app_env(
-        dsn: "http://public:secret@localhost:#{bypass.port}/1",
-        "#{__MODULE__.PhoenixEndpoint}": [
-          render_errors: [view: Sentry.ErrorView, accepts: ~w(html)]
-        ]
-      )
+      put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
       {:ok, _} = PhoenixEndpoint.start_link()
 
@@ -232,12 +230,7 @@ defmodule Sentry.PlugCaptureTest do
         Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
       end)
 
-      modify_app_env(
-        dsn: "http://public:secret@localhost:#{bypass.port}/1",
-        "#{__MODULE__.PhoenixEndpoint}": [
-          render_errors: [view: Sentry.ErrorView, accepts: ~w(html)]
-        ]
-      )
+      put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
       {:ok, _} = PhoenixEndpoint.start_link()
 
@@ -269,7 +262,7 @@ defmodule Sentry.PlugCaptureTest do
         Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
       end)
 
-      modify_app_env(dsn: "http://public:secret@localhost:#{bypass.port}/1")
+      put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
       start_supervised!(PhoenixEndpoint)
 
@@ -300,12 +293,7 @@ defmodule Sentry.PlugCaptureTest do
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(
-      dsn: "http://public:secret@localhost:#{bypass.port}/1",
-      "#{__MODULE__.PhoenixEndpoint}": [
-        render_errors: [view: Sentry.ErrorView, accepts: ~w(html)]
-      ]
-    )
+    put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
     {:ok, _} = PhoenixEndpoint.start_link()
 
@@ -337,7 +325,7 @@ defmodule Sentry.PlugCaptureTest do
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(dsn: "http://public:secret@localhost:#{bypass.port}/1")
+    put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
     conn = conn(:get, "/error_route")
 
@@ -363,12 +351,7 @@ defmodule Sentry.PlugCaptureTest do
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end)
 
-    modify_app_env(
-      dsn: "http://public:secret@localhost:#{bypass.port}/1",
-      "#{__MODULE__.PhoenixEndpoint}": [
-        render_errors: [view: Sentry.ErrorView, accepts: ~w(html)]
-      ]
-    )
+    put_test_config(dsn: "http://public:secret@localhost:#{bypass.port}/1")
 
     {:ok, _} = PhoenixEndpoint.start_link()