Add the conventional GenConsumer.Supervisor.start_link/1

This enables the usage of child_spec/1 and removal of the deprecated Supervisor.Spec.supervisor/3 call. Fixes kafkaex#390.
b1az · Aug 25, 2022 · c9c48e5 · c9c48e5
1 parent 081a14f
commit c9c48e5
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 15 deletions.
diff --git a/lib/kafka_ex/consumer_group.ex b/lib/kafka_ex/consumer_group.ex
@@ -334,9 +334,17 @@ defmodule KafkaEx.ConsumerGroup do
         opts
       ) do
     child =
-      supervisor(
-        KafkaEx.GenConsumer.Supervisor,
-        [{gen_consumer_module, consumer_module}, group_name, assignments, opts],
+      Supervisor.child_spec(
+        {
+          KafkaEx.GenConsumer.Supervisor,
+          %{
+            gen_consumer_module: gen_consumer_module,
+            consumer_module: consumer_module,
+            group_name: group_name,
+            assignments: assignments,
+            opts: opts
+          }
+        },
         id: :consumer
       )
 

diff --git a/lib/kafka_ex/gen_consumer/supervisor.ex b/lib/kafka_ex/gen_consumer/supervisor.ex
@@ -15,6 +15,7 @@ defmodule KafkaEx.GenConsumer.Supervisor do
 
   use DynamicSupervisor
 
+  @doc since: "0.14.0"
   @doc """
   Starts a `GenConsumer.Supervisor` process linked to the current process.
 
@@ -32,20 +33,22 @@ defmodule KafkaEx.GenConsumer.Supervisor do
   If the supervisor and its consumers are successfully created, this function
   returns `{:ok, pid}`, where `pid` is the PID of the supervisor.
   """
-  @spec start_link(
-          {gen_consumer_module :: module, consumer_module :: module},
-          consumer_group_name :: binary,
-          assigned_partitions :: [
+  @spec start_link(%{
+          gen_consumer_module: module,
+          consumer_module: module,
+          group_name: binary,
+          assignments: [
             {topic_name :: binary, partition_id :: non_neg_integer}
           ],
-          KafkaEx.GenConsumer.options()
-        ) :: Elixir.Supervisor.on_start()
-  def start_link(
-        {gen_consumer_module, consumer_module},
-        group_name,
-        assignments,
-        opts \\ []
-      ) do
+          opts: KafkaEx.GenConsumer.options()
+        }) :: Supervisor.on_start()
+  def start_link(%{
+    gen_consumer_module: gen_consumer_module,
+    consumer_module: consumer_module,
+    group_name: group_name,
+    assignments: assignments,
+    opts: opts
+  }) do
     start_link_result =
       DynamicSupervisor.start_link(
         __MODULE__,
@@ -71,6 +74,39 @@ defmodule KafkaEx.GenConsumer.Supervisor do
     end
   end
 
+  @deprecated "Use start_link/1 instead"
+  @doc """
+  Starts a `GenConsumer.Supervisor` process linked to the current process.
+
+  Refer to `start_link/1` for documentation of each parameter.
+
+  ### Return Values
+
+  Same as `start_link/1`.
+  """
+  @spec start_link(
+          {gen_consumer_module :: module, consumer_module :: module},
+          consumer_group_name :: binary,
+          assigned_partitions :: [
+            {topic_name :: binary, partition_id :: non_neg_integer}
+          ],
+          KafkaEx.GenConsumer.options()
+        ) :: Elixir.Supervisor.on_start()
+  def start_link(
+        {gen_consumer_module, consumer_module},
+        group_name,
+        assignments,
+        opts \\ []
+      ) do
+        start_link(%{
+          gen_consumer_module: gen_consumer_module,
+          consumer_module: consumer_module,
+          group_name: group_name,
+          assignments: assignments,
+          opts: opts
+        })
+  end
+
   @doc """
   Returns a list of child pids