feat!: add otp_app option to consumer and producer compile-time optio…

…ns to improve configurating the modules
stordco · Dec 26, 2023 · c700ace · c700ace
1 parent 460e678
commit c700ace
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 2 deletions.
diff --git a/lib/kafee/consumer.ex b/lib/kafee/consumer.ex
@@ -1,5 +1,17 @@
 defmodule Kafee.Consumer do
   @options_schema NimbleOptions.new!(
+                    otp_app: [
+                      default: nil,
+                      doc: """
+                      The name of the OTP application to read configuration from.
+
+                      If the option is set, the configuration will be read from the application environment under the
+                      given name. For example, if the OTP application is `:my_app`, the configuration will be read from
+                      `Application.get_env(:my_app, Myapp.KafeeConsumer)`.
+                      """,
+                      required: true,
+                      type: :atom
+                    ],
                     adapter: [
                       default: nil,
                       doc: """
@@ -197,7 +209,13 @@ defmodule Kafee.Consumer do
       @doc false
       @spec child_spec(Kafee.Consumer.options()) :: Supervisor.child_spec()
       def child_spec(args) do
-        full_opts = Keyword.merge(unquote(Macro.escape(opts)), args)
+        opts = unquote(Macro.escape(opts))
+        env_opts = Application.get_env(opts[:otp_app], unquote(__MODULE__), [])
+
+        full_opts =
+          opts
+          |> Keyword.merge(env_opts)
+          |> Keyword.merge(args)
 
         %{
           id: __MODULE__,

diff --git a/lib/kafee/producer.ex b/lib/kafee/producer.ex
@@ -1,5 +1,17 @@
 defmodule Kafee.Producer do
   @options_schema NimbleOptions.new!(
+                    otp_app: [
+                      default: nil,
+                      doc: """
+                      The name of the OTP application to read configuration from.
+
+                      If the option is set, the configuration will be read from the application environment under the
+                      given name. For example, if the OTP application is `:my_app`, the configuration will be read from
+                      `Application.get_env(:my_app, Myapp.KafeeProducer)`.
+                      """,
+                      required: true,
+                      type: :atom
+                    ],
                     adapter: [
                       default: nil,
                       doc: """
@@ -213,7 +225,13 @@ defmodule Kafee.Producer do
       @doc false
       @spec child_spec(Kafee.Producer.options()) :: Supervisor.child_spec()
       def child_spec(args) do
-        full_opts = Keyword.merge(unquote(Macro.escape(opts)), args)
+        opts = unquote(Macro.escape(opts))
+        env_opts = Application.get_env(opts[:otp_app], unquote(__MODULE__), [])
+
+        full_opts =
+          opts
+          |> Keyword.merge(env_opts)
+          |> Keyword.merge(args)
 
         %{
           id: __MODULE__,

diff --git a/test/kafee/consumer/broadway_adapter_integration_test.exs b/test/kafee/consumer/broadway_adapter_integration_test.exs
@@ -3,6 +3,7 @@ defmodule Kafee.Consumer.BroadwayAdapterIntegrationTest do
 
   defmodule MyConsumer do
     use Kafee.Consumer,
+      otp_app: :kafee,
       adapter: {Kafee.Consumer.BroadwayAdapter, []}
 
     def handle_message(%Kafee.Consumer.Message{} = message) do

diff --git a/test/kafee/consumer/brod_adapter_integration_test.exs b/test/kafee/consumer/brod_adapter_integration_test.exs
@@ -3,6 +3,7 @@ defmodule Kafee.Consumer.BrodAdapterIntegrationTest do
 
   defmodule MyConsumer do
     use Kafee.Consumer,
+      otp_app: :kafee,
       adapter: Kafee.Consumer.BrodAdapter
 
     def handle_message(%Kafee.Consumer.Message{} = message) do