define finch opts and update logger/send_test_event tests

Author: savhappy

config/config.exs

@@ -6,7 +6,7 @@ if config_env() == :test do
     tags: %{},
     enable_source_code_context: true,
     root_source_code_paths: [File.cwd!()],
-    hackney_opts: [recv_timeout: 50, pool: :sentry_pool],
+    finch_request_opts: [receive_timeout: 50],
     send_result: :sync,
     send_max_attempts: 1,
     dedup_events: false,
@@ -16,3 +16,6 @@ if config_env() == :test do
 end
 
 config :phoenix, :json_library, if(Code.ensure_loaded?(JSON), do: JSON, else: Jason)
+
+config :sentry,
+  client: Sentry.FinchClient

lib/mix/tasks/sentry.send_test_event.ex

@@ -67,7 +67,7 @@ defmodule Mix.Tasks.Sentry.SendTestEvent do
     end
 
     Mix.shell().info("current environment_name: #{inspect(to_string(Config.environment_name()))}")
-    Mix.shell().info("hackney_opts: #{inspect(Config.hackney_opts())}\n")
+    Mix.shell().info("finch_pool_opts: #{inspect(Config.finch_pool_opts())}\n")
   end
 
   defp send_event(opts) do

lib/sentry/config.ex

@@ -316,7 +316,7 @@ defmodule Sentry.Config do
       The maximum number of attempts to send an event to Sentry.
       """
     ],
-    finch_opts: [
+    finch_pool_opts: [
       type: :keyword_list,
       default: [size: 50, conn_max_idle_time: 5000],
       doc: """
@@ -326,32 +326,48 @@ defmodule Sentry.Config do
       for available options.
       """
     ],
-    hackney_opts: [
+    finch_request_opts: [
       type: :keyword_list,
-      default: [pool: :sentry_pool],
+      default: [receive_timeout: 50],
       doc: """
-      Options to be passed to `hackney`. Only
-      applied if `:client` is set to `Sentry.HackneyClient`.
-      """
-    ],
-    hackney_pool_timeout: [
-      type: :timeout,
-      default: 5000,
-      doc: """
-      The maximum time to wait for a
-      connection to become available. Only applied if `:client` is set to
-      `Sentry.HackneyClient`.
+      Request options to be passed to `Finch.request/4`. These options control
+      individual request behavior. Only applied if `:client` is set to
+      `Sentry.FinchClient`. See [Finch documentation](https://hexdocs.pm/finch/Finch.html#request/4)
+      for available options.
       """
     ],
-    hackney_pool_max_connections: [
-      type: :pos_integer,
-      default: 50,
-      doc: """
-      The maximum number of
-      connections to keep in the pool. Only applied if `:client` is set to
-      `Sentry.HackneyClient`.
-      """
-    ]
+    hackney_opts:
+      [
+        type: :keyword_list,
+        default: [pool: :sentry_pool],
+        doc: """
+        Options to be passed to `hackney`. Only
+        applied if `:client` is set to `Sentry.HackneyClient`.
+        """
+      ] ++
+        if(Mix.env() == :test, do: [], else: [deprecated: "Use Finch instead as default client."]),
+    hackney_pool_timeout:
+      [
+        type: :timeout,
+        default: 5000,
+        doc: """
+        The maximum time to wait for a
+        connection to become available. Only applied if `:client` is set to
+        `Sentry.HackneyClient`.
+        """
+      ] ++
+        if(Mix.env() == :test, do: [], else: [deprecated: "Use Finch instead as default client."]),
+    hackney_pool_max_connections:
+      [
+        type: :pos_integer,
+        default: 50,
+        doc: """
+        The maximum number of
+        connections to keep in the pool. Only applied if `:client` is set to
+        `Sentry.HackneyClient`.
+        """
+      ] ++
+        if(Mix.env() == :test, do: [], else: [deprecated: "Use Finch instead as default client."])
   ]
 
   source_code_context_opts_schema = [
@@ -617,8 +633,11 @@ defmodule Sentry.Config do
   @spec sample_rate() :: float()
   def sample_rate, do: fetch!(:sample_rate)
 
-  @spec finch_opts() :: keyword()
-  def finch_opts, do: fetch!(:finch_opts)
+  @spec finch_pool_opts() :: keyword()
+  def finch_pool_opts, do: fetch!(:finch_pool_opts)
+
+  @spec finch_request_opts() :: keyword()
+  def finch_request_opts, do: fetch!(:finch_request_opts)
 
   @spec hackney_opts() :: keyword()
   def hackney_opts, do: fetch!(:hackney_opts)

lib/sentry/finch_client.ex

@@ -23,7 +23,7 @@ defmodule Sentry.FinchClient do
       Finch.child_spec(
         name: __MODULE__,
         pools: %{
-          :default => Sentry.Config.finch_opts()
+          :default => Sentry.Config.finch_pool_opts()
         }
       )
     else
@@ -39,7 +39,7 @@ defmodule Sentry.FinchClient do
   def post(url, headers, body) do
     request = Finch.build(:post, url, headers, body)
 
-    case Finch.request(request, __MODULE__) do
+    case Finch.request(request, __MODULE__, Sentry.Config.finch_request_opts()) do
       {:ok, %Finch.Response{status: status, headers: headers, body: body}} ->
         {:ok, status, headers, body}
 

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
-    put_test_config(dsn: nil, hackney_opts: [], environment_name: "some_env")
+    put_test_config(dsn: nil, finch_pool_opts: [], environment_name: "some_env")
 
     output =
       capture_io(fn ->
@@ -15,7 +15,7 @@ defmodule Mix.Tasks.Sentry.SendTestEventTest do
     assert output =~ """
            Client configuration:
            current environment_name: "some_env"
-           hackney_opts: []
+           finch_pool_opts: []
            """
 
     assert output =~ ~s(Event not sent because the :dsn option is not set)
@@ -35,7 +35,7 @@ defmodule Mix.Tasks.Sentry.SendTestEventTest do
     put_test_config(
       dsn: "http://public:secret@localhost:#{bypass.port}/1",
       environment_name: "test",
-      hackney_opts: []
+      finch_pool_opts: []
     )
 
     output =
@@ -49,7 +49,7 @@ defmodule Mix.Tasks.Sentry.SendTestEventTest do
            public_key: public
            secret_key: secret
            current environment_name: "test"
-           hackney_opts: []
+           finch_pool_opts: []
            """
 
     assert output =~ "Sending test event..."

test/sentry/logger_handler_test.exs

@@ -685,7 +685,7 @@ defmodule Sentry.LoggerHandlerTest do
     put_test_config(
       dsn: "http://public:secret@localhost:#{bypass.port}/1",
       dedup_events: false,
-      hackney_opts: [recv_timeout: 500, pool: :sentry_pool]
+      finch_request_opts: [receive_timeout: 500]
     )
 
     Bypass.expect(bypass, fn conn ->

test/sentry_test.exs

@@ -51,7 +51,7 @@ defmodule SentryTest do
   test "errors when taking too long to receive response", %{bypass: bypass} do
     Bypass.expect(bypass, fn _conn -> Process.sleep(:infinity) end)
 
-    put_test_config(hackney_opts: [recv_timeout: 50])
+    put_test_config(finch_request_opts: [receive_timeout: 50])
 
     assert {:error,
             %Sentry.ClientError{