Remove gen_state_machine dependency

This fixes a few compiler warnings.
nerves-networking · Feb 17, 2025 · 7f2ba92 · 7f2ba92
1 parent 0045e4e
commit 7f2ba92
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 35 deletions.
diff --git a/lib/vintage_net/interface.ex b/lib/vintage_net/interface.ex
@@ -8,7 +8,7 @@ defmodule VintageNet.Interface do
   The actual code that supplies the configuration implements the `VintageNet.Technology`
   behaviour.
   """
-  use GenStateMachine
+  @behaviour :gen_statem
 
   alias VintageNet.Interface.CommandRunner
   alias VintageNet.Interface.RawConfig
@@ -28,6 +28,17 @@ defmodule VintageNet.Interface do
             waiters: [],
             inflight_ioctls: %{}
 
+  @spec child_spec(VintageNet.ifname()) :: Supervisor.child_spec()
+  def child_spec(init_arg) do
+    %{
+      id: __MODULE__,
+      start: {__MODULE__, :start_link, [init_arg]},
+      restart: :permanent,
+      shutdown: 5000,
+      type: :worker
+    }
+  end
+
   @doc """
   Start up an interface
 
@@ -37,7 +48,7 @@ defmodule VintageNet.Interface do
   """
   @spec start_link(VintageNet.ifname()) :: GenServer.on_start()
   def start_link(ifname) do
-    GenStateMachine.start_link(__MODULE__, ifname, name: via_name(ifname))
+    :gen_statem.start_link(via_name(ifname), __MODULE__, ifname, [])
   end
 
   defp via_name(ifname) do
@@ -51,7 +62,7 @@ defmodule VintageNet.Interface do
   """
   @spec stop(VintageNet.ifname()) :: :ok
   def stop(ifname) do
-    GenStateMachine.stop(via_name(ifname))
+    :gen_statem.stop(via_name(ifname))
   end
 
   @doc """
@@ -112,7 +123,7 @@ defmodule VintageNet.Interface do
          persist_configuration(ifname, normalized_config, options),
          PropertyTable.put(VintageNet, ["interface", ifname, "config"], normalized_config),
          {:error, :already_started} <- maybe_start_interface(ifname) do
-      GenStateMachine.call(via_name(raw_config.ifname), {:configure, raw_config})
+      :gen_statem.call(via_name(raw_config.ifname), {:configure, raw_config})
     end
   end
 
@@ -160,15 +171,15 @@ defmodule VintageNet.Interface do
   """
   @spec wait_until_configured(VintageNet.ifname()) :: :ok
   def wait_until_configured(ifname) do
-    GenStateMachine.call(via_name(ifname), :wait)
+    :gen_statem.call(via_name(ifname), :wait)
   end
 
   @doc """
   Run an I/O command on the specified interface
   """
   @spec ioctl(VintageNet.ifname(), atom(), any()) :: :ok | {:ok, any()} | {:error, any()}
   def ioctl(ifname, command, args) do
-    GenStateMachine.call(via_name(ifname), {:ioctl, command, args})
+    :gen_statem.call(via_name(ifname), {:ioctl, command, args})
   end
 
   defp debug(data, message), do: log(:debug, data.ifname, message)
@@ -177,7 +188,7 @@ defmodule VintageNet.Interface do
     Logger.log(level, ["VintageNet(", ifname, "): ", message])
   end
 
-  @impl GenStateMachine
+  @impl :gen_statem
   def init(ifname) do
     Process.flag(:trap_exit, true)
 
@@ -209,9 +220,11 @@ defmodule VintageNet.Interface do
     end
   end
 
-  # :configuring
+  @impl :gen_statem
+  def callback_mode(), do: :handle_event_function
 
-  @impl GenStateMachine
+  # :configuring
+  @impl :gen_statem
   def handle_event(:info, {:commands_done, :ok}, :configuring, %__MODULE__{} = data) do
     # debug(data, ":configuring -> done success")
     {new_data, actions} = reply_to_waiters(data)
@@ -228,7 +241,6 @@ defmodule VintageNet.Interface do
     {:next_state, :configured, new_data, actions}
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {:commands_done, {:error, _reason}},
@@ -243,7 +255,6 @@ defmodule VintageNet.Interface do
     {:next_state, :retrying, new_data, actions}
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {:EXIT, pid, reason},
@@ -262,7 +273,6 @@ defmodule VintageNet.Interface do
     {:next_state, :retrying, new_data, actions}
   end
 
-  @impl GenStateMachine
   def handle_event(
         :state_timeout,
         _event,
@@ -279,7 +289,6 @@ defmodule VintageNet.Interface do
     {:next_state, :retrying, new_data, actions}
   end
 
-  @impl GenStateMachine
   def handle_event(
         {:call, from},
         {:configure, new_config},
@@ -299,7 +308,6 @@ defmodule VintageNet.Interface do
     start_configuring(new_config, new_data, actions)
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {VintageNet, ["interface", an_ifname, "present"], _old_value, nil, _meta},
@@ -323,7 +331,6 @@ defmodule VintageNet.Interface do
     {:keep_state, data, {:reply, from, :ok}}
   end
 
-  @impl GenStateMachine
   def handle_event(
         :internal,
         {:configure, new_config},
@@ -344,7 +351,6 @@ defmodule VintageNet.Interface do
     {:next_state, :reconfiguring, %{new_data | next_config: new_config}, actions}
   end
 
-  @impl GenStateMachine
   def handle_event(
         {:call, from},
         {:configure, new_config},
@@ -366,7 +372,6 @@ defmodule VintageNet.Interface do
     {:next_state, :reconfiguring, %{new_data | next_config: new_config}, actions}
   end
 
-  @impl GenStateMachine
   def handle_event(
         {:call, from},
         {:ioctl, command, args},
@@ -382,7 +387,6 @@ defmodule VintageNet.Interface do
     {:keep_state, new_data}
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {:ioctl_done, ioctl_pid, result},
@@ -398,7 +402,6 @@ defmodule VintageNet.Interface do
     {:keep_state, new_data, action}
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {:EXIT, pid, reason},
@@ -421,7 +424,6 @@ defmodule VintageNet.Interface do
     end
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {VintageNet, ["interface", an_ifname, "present"], _old_value, nil, _meta},
@@ -444,7 +446,6 @@ defmodule VintageNet.Interface do
 
   # :reconfiguring
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {:commands_done, :ok},
@@ -472,7 +473,6 @@ defmodule VintageNet.Interface do
     end
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {:commands_done, {:error, _reason}},
@@ -499,7 +499,6 @@ defmodule VintageNet.Interface do
     end
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {:EXIT, pid, reason},
@@ -526,7 +525,6 @@ defmodule VintageNet.Interface do
     end
   end
 
-  @impl GenStateMachine
   def handle_event(
         :state_timeout,
         _event,
@@ -555,7 +553,6 @@ defmodule VintageNet.Interface do
 
   # :retrying
 
-  @impl GenStateMachine
   def handle_event(:state_timeout, _event, :retrying, %__MODULE__{config: new_config} = data) do
     if interfaces_available?(data) do
       start_configuring(new_config, data, [])
@@ -564,7 +561,6 @@ defmodule VintageNet.Interface do
     end
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {VintageNet, ["interface", an_ifname, "present"], _old_value, true, _meta},
@@ -580,7 +576,6 @@ defmodule VintageNet.Interface do
     end
   end
 
-  @impl GenStateMachine
   def handle_event(
         {:call, from},
         {:configure, new_config},
@@ -600,7 +595,6 @@ defmodule VintageNet.Interface do
     end
   end
 
-  @impl GenStateMachine
   def handle_event(:info, {:commands_done, _}, :retrying, %__MODULE__{} = data) do
     # This is a latent message that didn't get processed because a crash
     # got handled first. It can be produced by getting one of an
@@ -610,14 +604,12 @@ defmodule VintageNet.Interface do
   end
 
   # Catch all event handlers
-  @impl GenStateMachine
   def handle_event(:info, {:EXIT, _pid, _reason}, _state, data) do
     # Ignore latent or expected command runner and ioctl exits
     # debug(data, "#{inspect(state)} -> process exit (ignoring)")
     {:keep_state, data}
   end
 
-  @impl GenStateMachine
   def handle_event(
         {:call, from},
         :wait,
@@ -628,7 +620,6 @@ defmodule VintageNet.Interface do
     {:keep_state, %{data | waiters: [from | waiters]}}
   end
 
-  @impl GenStateMachine
   def handle_event(
         {:call, from},
         {:ioctl, _command, _args},
@@ -639,7 +630,6 @@ defmodule VintageNet.Interface do
     {:keep_state, data, {:reply, from, {:error, :unconfigured}}}
   end
 
-  @impl GenStateMachine
   def handle_event(
         :info,
         {VintageNet, ["interface", ifname, "present"], _old_value, present, _meta},
@@ -650,7 +640,7 @@ defmodule VintageNet.Interface do
     {:keep_state, data}
   end
 
-  @impl GenStateMachine
+  @impl :gen_statem
   def terminate(_reason, _state, %{ifname: ifname}) do
     PropertyTable.delete(VintageNet, ["interface", ifname, "type"])
     PropertyTable.delete(VintageNet, ["interface", ifname, "state"])

diff --git a/mix.exs b/mix.exs
@@ -98,7 +98,6 @@ defmodule VintageNet.MixProject do
     [
       # Runtime dependencies
       {:beam_notify, "~> 1.0 or ~> 0.2.0"},
-      {:gen_state_machine, "~> 2.0.0 or ~> 2.1.0 or ~> 3.0.0"},
       {:muontrap, "~> 1.0 or ~> 0.5.1 or ~> 0.6.0"},
       {:property_table, "~> 0.2.0 or ~> 0.3.0"},
       # Build dependencies

diff --git a/mix.lock b/mix.lock
@@ -9,7 +9,6 @@
   "erlex": {:hex, :erlex, "0.2.7", "810e8725f96ab74d17aac676e748627a07bc87eb950d2b83acd29dc047a30595", [:mix], [], "hexpm", "3ed95f79d1a844c3f6bf0cea61e0d5612a42ce56da9c03f01df538685365efb0"},
   "ex_doc": {:hex, :ex_doc, "0.37.1", "65ca30d242082b95aa852b3b73c9d9914279fff56db5dc7b3859be5504417980", [:mix], [{:earmark_parser, "~> 1.4.42", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "6774f75477733ea88ce861476db031f9399c110640752ca2b400dbbb50491224"},
   "file_system": {:hex, :file_system, "1.1.0", "08d232062284546c6c34426997dd7ef6ec9f8bbd090eb91780283c9016840e8f", [:mix], [], "hexpm", "bfcf81244f416871f2a2e15c1b515287faa5db9c6bcf290222206d120b3d43f6"},
-  "gen_state_machine": {:hex, :gen_state_machine, "3.0.0", "1e57f86a494e5c6b14137ebef26a7eb342b3b0070c7135f2d6768ed3f6b6cdff", [:mix], [], "hexpm", "0a59652574bebceb7309f6b749d2a41b45fdeda8dbb4da0791e355dd19f0ed15"},
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
   "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
   "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},