Switch HTTP client from hackney to finch

README.md

@@ -18,7 +18,7 @@ This is the official Sentry SDK for [Sentry].
 
 ### Install
 
-To use Sentry in your project, add it as a dependency in your `mix.exs` file. Sentry does not install a JSON library nor HTTP client by itself. Sentry will default to trying to use [Jason] for JSON serialization and [Hackney] for HTTP requests, but can be configured to use other ones. To use the default ones, do:
+To use Sentry in your project, add it as a dependency in your `mix.exs` file. Sentry does not install a JSON library nor HTTP client by itself. Sentry will default to trying to use [Jason] for JSON serialization and [Finch] for HTTP requests, but can be configured to use other ones. To use the default ones, do:
 
 ```elixir
 defp deps do
@@ -27,7 +27,7 @@ defp deps do
 
     {:sentry, "~> 10.0"},
     {:jason, "~> 1.4"},
-    {:hackney, "~> 1.19"}
+    {:finch, "~> 0.18"}
   ]
 end
 ```
@@ -149,7 +149,7 @@ Licensed under the MIT license, see [`LICENSE`](./LICENSE).
 
 [Sentry]: http://sentry.io/
 [Jason]: https://github.com/michalmuskala/jason
-[Hackney]: https://github.com/benoitc/hackney
+[Finch]: https://github.com/sneako/finch
 [Bypass]: https://github.com/PSPDFKit-labs/bypass
 [docs]: https://hexdocs.pm/sentry/readme.html
 [logger-handlers]: https://www.erlang.org/doc/apps/kernel/logger_chapter#handlers

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_opts: [recv_timeout: 50],
     send_result: :sync,
     send_max_attempts: 1,
     dedup_events: false,

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 options: #{inspect(Config.finch_opts())}\n")
   end
 
   defp send_event(opts) do

lib/sentry/config.ex

@@ -239,11 +239,11 @@ defmodule Sentry.Config do
     client: [
       type: :atom,
       type_doc: "`t:module/0`",
-      default: Sentry.HackneyClient,
+      default: Sentry.FinchClient,
       doc: """
       A module that implements the `Sentry.HTTPClient`
-      behaviour. Defaults to `Sentry.HackneyClient`, which uses
-      [hackney](https://github.com/benoitc/hackney) as the HTTP client.
+      behaviour. Defaults to `Sentry.FinchClient`, which uses
+      [Finch](https://github.com/sneako/finch) as the HTTP client.
       """
     ],
     send_max_attempts: [
@@ -253,8 +253,35 @@ defmodule Sentry.Config do
       The maximum number of attempts to send an event to Sentry.
       """
     ],
+    finch_opts: [
+      type: :keyword_list,
+      default: [pool: :sentry_pool],
+      doc: """
+      Options to be passed to `finch`. Only
+      applied if `:client` is set to `Sentry.FinchClient`.
+      """
+    ],
+    finch_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.FinchClient`.
+      """
+    ],
+    finch_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.FinchClient`.
+      """
+    ],
     hackney_opts: [
       type: :keyword_list,
+      deprecated: "Use Finch instead as default client.",
       default: [pool: :sentry_pool],
       doc: """
       Options to be passed to `hackney`. Only
@@ -263,6 +290,7 @@ defmodule Sentry.Config do
     ],
     hackney_pool_timeout: [
       type: :timeout,
+      deprecated: "Use Finch instead as default client.",
       default: 5000,
       doc: """
       The maximum time to wait for a
@@ -272,6 +300,7 @@ defmodule Sentry.Config do
     ],
     hackney_pool_max_connections: [
       type: :pos_integer,
+      deprecated: "Use Finch instead as default client.",
       default: 50,
       doc: """
       The maximum number of
@@ -470,11 +499,11 @@ defmodule Sentry.Config do
   @spec environment_name() :: String.t() | nil
   def environment_name, do: fetch!(:environment_name)
 
-  @spec max_hackney_connections() :: pos_integer()
-  def max_hackney_connections, do: fetch!(:hackney_pool_max_connections)
+  @spec max_finch_connections() :: pos_integer()
+  def max_finch_connections, do: fetch!(:finch_pool_max_connections)
 
-  @spec hackney_timeout() :: timeout()
-  def hackney_timeout, do: fetch!(:hackney_pool_timeout)
+  @spec finch_timeout() :: timeout()
+  def finch_timeout, do: fetch!(:finch_pool_timeout)
 
   @spec tags() :: map()
   def tags, do: fetch!(:tags)
@@ -512,8 +541,8 @@ defmodule Sentry.Config do
   @spec sample_rate() :: float()
   def sample_rate, do: fetch!(:sample_rate)
 
-  @spec hackney_opts() :: keyword()
-  def hackney_opts, do: fetch!(:hackney_opts)
+  @spec finch_opts() :: keyword()
+  def finch_opts, do: fetch!(:finch_opts)
 
   @spec before_send() :: (Sentry.Event.t() -> Sentry.Event.t()) | {module(), atom()} | nil
   def before_send, do: get(:before_send)

lib/sentry/envelope.ex

@@ -51,7 +51,6 @@ defmodule Sentry.Envelope do
       end
 
     items_iodata = Enum.map(envelope.items, &item_to_binary(json_library, &1))
-
     {:ok, IO.iodata_to_binary([headers_iodata, items_iodata])}
   catch
     {:error, _reason} = error -> error

lib/sentry/finch_client.ex

@@ -0,0 +1,56 @@
+defmodule Sentry.FinchClient do
+  @behaviour Sentry.HTTPClient
+
+  @moduledoc """
+  The built-in HTTP client.
+
+  This client implements the `Sentry.HTTPClient` behaviour.
+
+  It's based on the [Finch](https://github.com/sneako/finch) Elixir HTTP client,
+  which is an *optional dependency* of this library. If you wish to use another
+  HTTP client, you'll have to implement your own `Sentry.HTTPClient`. See the
+  documentation for `Sentry.HTTPClient` for more information.
+
+  Finch is built on top of [NimblePool](https://github.com/dashbitco/nimble_pool). If you need to set other pool configuration options,
+  see "Pool Configuration Options" in the Finch documentation for details on the possible map values.
+  [finch configuration options](https://hexdocs.pm/finch/Finch.html#start_link/1-pool-configuration-options)
+  """
+  @impl true
+  def child_spec do
+    if Code.ensure_loaded?(Finch) do
+      case Application.ensure_all_started(:finch) do
+        {:ok, _apps} -> :ok
+        {:error, reason} -> raise "failed to start the :finch application: #{inspect(reason)}"
+      end
+
+      Finch.child_spec(
+        name: __MODULE__,
+        pools: %{
+          :default => [
+            size: Sentry.Config.max_finch_connections(),
+            conn_max_idle_time: Sentry.Config.finch_timeout()
+          ]
+        }
+      )
+    else
+      raise """
+      cannot start the :sentry application because the HTTP client is set to \
+      Sentry.FinchClient (which is the default), but the :finch library is not loaded. \
+      Add :finch to your dependencies to fix this.
+      """
+    end
+  end
+
+  @impl true
+  def post(url, headers, body) do
+    request = Finch.build(:post, url, headers, body)
+
+    case Finch.request(request, __MODULE__) do
+      {:ok, %Finch.Response{status: status, headers: headers, body: body}} ->
+        {:ok, status, headers, body}
+
+      {:error, error} ->
+        {:error, error}
+    end
+  end
+end

lib/sentry/http_client.ex

@@ -2,7 +2,7 @@ defmodule Sentry.HTTPClient do
   @moduledoc """
   A behaviour for HTTP clients that Sentry can use.
 
-  The default HTTP client is `Sentry.HackneyClient`.
+  The default HTTP client is `Sentry.FinchClient`.
 
   To configure a different HTTP client, implement the `Sentry.HTTPClient` behaviour and
   change the `:client` configuration:
@@ -25,46 +25,45 @@ defmodule Sentry.HTTPClient do
   ## Alternative Clients
 
   Let's look at an example of using an alternative HTTP client. In this example, we'll
-  use [Finch](https://github.com/sneako/finch), a lightweight HTTP client for Elixir.
+  use [Hackney](https://github.com/benoitc/hackney), a lightweight HTTP client for Elixir.
 
-  First, we need to add Finch to our dependencies:
+  First, we need to add Hackney to our dependencies:
 
       # In mix.exs
       defp deps do
         [
           # ...
-          {:finch, "~> 0.16"}
+          {:hackney, "~> 1.8"}
         ]
       end
 
   Then, we need to define a module that implements the `Sentry.HTTPClient` behaviour:
 
-      defmodule MyApp.SentryFinchHTTPClient do
+      defmodule MyApp.SentryHackneyHTTPClient do
         @behaviour Sentry.HTTPClient
 
-        @impl true
-        def child_spec do
-          Supervisor.child_spec({Finch, name: __MODULE__}, id: __MODULE__)
+        # @impl true
+        # def child_spec do
+        #     :hackney_pool.child_spec(
+        #       @hackney_pool_name,
+        #       timeout: Sentry.Config.hackney_timeout(),
+        #       max_connections: Sentry.Config.max_hackney_connections()
+        #     )
+        # end
+
+        # @impl true
+        # def post(url, headers, body) do
+        #   case :hackney.request(:post, url, headers, body) do
+        #     {:ok, _status, _headers, _body} = result -> result
+        #     {:error, _reason} = error -> error
+        #   end
+        # end
         end
 
-        @impl true
-        def post(url, headers, body) do
-          request = Finch.build(:post, url, headers, body)
-
-          case Finch.request(request, __MODULE__) do
-            {:ok, %Finch.Response{status: status, headers: headers, body: body}} ->
-              {:ok, status, headers, body}
-
-            {:error, error} ->
-              {:error, error}
-          end
-        end
-      end
-
   Last, we need to configure Sentry to use our new HTTP client:
 
       config :sentry,
-        client: MyApp.SentryFinchHTTPClient
+        client: Sentry.HackneyClient
 
   ### Umbrella Apps
 

mix.exs

@@ -49,7 +49,7 @@ defmodule Sentry.Mixfile do
           "Plug and Phoenix": [Sentry.PlugCapture, Sentry.PlugContext, Sentry.LiveViewHook],
           Loggers: [Sentry.LoggerBackend, Sentry.LoggerHandler],
           "Data Structures": [Sentry.Attachment, Sentry.CheckIn],
-          HTTP: [Sentry.HTTPClient, Sentry.HackneyClient],
+          HTTP: [Sentry.HTTPClient, Sentry.FinchClient],
           Interfaces: [~r/^Sentry\.Interfaces/],
           Testing: [Sentry.Test]
         ],
@@ -63,7 +63,7 @@ defmodule Sentry.Mixfile do
         ],
         authors: ["Mitchell Henke", "Jason Stiebs", "Andrea Leopardi"]
       ],
-      xref: [exclude: [:hackney, :hackney_pool, Plug.Conn, :telemetry]],
+      xref: [exclude: [Finch, Plug.Conn, :telemetry]],
       aliases: [aliases()]
     ]
   end
@@ -89,7 +89,7 @@ defmodule Sentry.Mixfile do
       {:nimble_ownership, "~> 0.3.0"},
 
       # Optional dependencies
-      {:hackney, "~> 1.8", optional: true},
+      {:finch, "~> 0.18.0", optional: true},
       {:jason, "~> 1.1", optional: true},
       {:phoenix, "~> 1.6", optional: true},
       {:phoenix_live_view, "~> 0.20", optional: true},