Skip to content

Commit d27cebf

Browse files
committed
Use :name in child spec as child id
This is similar to sneako/finch@6b42c8e While at it I made the following change which fixes what I think was unintentional ommision of interpolation: - defp to_name(name), do: :"__MODULE__:#{name}" + defp to_name(name), do: :"#{inspect(__MODULE__)}:#{name}" I also noticed we have: def start_link(opts) when is_list(opts) do with {:ok, name} <- Keyword.fetch(opts, :name) do GenServer.start_link(__MODULE__, opts, name: to_name(name)) end end And so if we do this, i.e. don't pass :name, we'll get :error iex> Meilisearch.start_link([]) :error That is not a common return value from start_link. Supervisor will crash on it. So while the `child_spec/1` change that I am proposing is technically a breaking change I think it is warranted as the current behaviour under that circumstance, not passing name, was also crashing. In this spirit, my suggestion is to change start_link, something like: def start_link(opts) when is_list(opts) do - with {:ok, name} <- Keyword.fetch(opts, :name) do - GenServer.start_link(__MODULE__, opts, name: to_name(name)) - end + name = Keyword.fetch!(opts, :name) + GenServer.start_link(__MODULE__, opts, name: to_name(name)) end Which I'm happy to do. let me know!
1 parent 3163843 commit d27cebf

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

lib/meilisearch.ex

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,16 @@ defmodule Meilisearch do
7878

7979
use GenServer
8080

81-
defp to_name(name), do: :"__MODULE__:#{name}"
81+
def child_spec(opts) do
82+
name = Keyword.fetch!(opts, :name)
83+
84+
%{
85+
id: name,
86+
start: {__MODULE__, :start_link, [opts]}
87+
}
88+
end
89+
90+
defp to_name(name), do: :"#{inspect(__MODULE__)}:#{name}"
8291

8392
@spec start_link(atom(),
8493
endpoint: String.t(),

0 commit comments

Comments
 (0)