fix: properly clean up state on sign out

Author: jlestel

lib/teslamate/api.ex

@@ -81,10 +81,10 @@ defmodule TeslaMate.Api do
   end
 
   def sign_out(name \\ @name) do
-    true = :ets.delete(name, :auth)
-    :ok
-  rescue
-    _ in ArgumentError -> {:error, :not_signed_in}
+    case fetch_auth(name) do
+      {:error, :not_signed_in} -> {:error, :not_signed_in}
+      {:ok, %Auth{}} -> GenServer.call(name, :sign_out, @timeout)
+    end
   end
 
   # Callbacks
@@ -173,6 +173,14 @@ defmodule TeslaMate.Api do
     end
   end
 
+  def handle_call(:sign_out, _from, %State{name: name} = state) do
+    :ets.delete(name, :auth)
+    if is_reference(state.refresh_timer), do: Process.cancel_timer(state.refresh_timer)
+    :ok = call(state.deps.auth, :delete_tokens)
+    :ok = call(state.deps.vehicles, :restart)
+    {:reply, :ok, %State{state | refresh_timer: nil}}
+  end
+
   @impl true
   def handle_info(:refresh_auth, %State{name: name} = state) do
     case fetch_auth(name) do

lib/teslamate/auth.ex

@@ -57,6 +57,11 @@ defmodule TeslaMate.Auth do
     end
   end
 
+  def delete_tokens do
+    Repo.delete_all(Tokens)
+    :ok
+  end
+
   defp create_tokens(attrs) do
     %Tokens{}
     |> Tokens.changeset(attrs)

test/support/mocks/auth.ex

@@ -12,6 +12,7 @@ defmodule AuthMock do
 
   def get_tokens(name), do: GenServer.call(name, :get_tokens)
   def save(name, auth), do: GenServer.call(name, {:save, auth})
+  def delete_tokens(name), do: GenServer.call(name, :delete_tokens)
 
   # Callbacks
 
@@ -33,4 +34,9 @@ defmodule AuthMock do
     send(pid, {AuthMock, event})
     {:reply, :ok, state}
   end
+
+  def handle_call(:delete_tokens = event, _from, %State{pid: pid} = state) do
+    send(pid, {AuthMock, event})
+    {:reply, :ok, %State{state | tokens: nil}}
+  end
 end

test/teslamate/api_test.exs

@@ -165,6 +165,37 @@ defmodule TeslaMate.ApiTest do
     end
   end
 
+  describe "sign out" do
+    test "deletes the tokens and restarts the vehicles", %{test: name} do
+      with_mocks [auth_mock(self()), vehicle_mock(self())] do
+        :ok = start_api(name, tokens: @valid_tokens)
+
+        assert_receive {TeslaApi.Auth, {:refresh, %TeslaApi.Auth{}}}
+        assert_receive {AuthMock, {:save, %TeslaApi.Auth{}}}
+        assert true == Api.signed_in?(name)
+
+        assert :ok = Api.sign_out(name)
+
+        assert_receive {AuthMock, :delete_tokens}
+        assert_receive {VehiclesMock, :restart}
+        assert false == Api.signed_in?(name)
+
+        refute_receive _
+      end
+    end
+
+    test "fails if not signed in", %{test: name} do
+      with_mocks [auth_mock(self()), vehicle_mock(self())] do
+        :ok = start_api(name, tokens: nil)
+
+        assert false == Api.signed_in?(name)
+        assert {:error, :not_signed_in} = Api.sign_out(name)
+
+        refute_receive _
+      end
+    end
+  end
+
   describe "refresh" do
     test "refreshes tokens", %{test: name} do
       with_mocks [auth_mock(self()), vehicle_mock(self())] do

test/teslamate/auth_test.exs

@@ -36,5 +36,19 @@ defmodule TeslaMate.AuthTest do
       assert %{refresh: ["can't be blank"], access: ["can't be blank"]} ==
                errors_on(changeset)
     end
+
+    test "delete_tokens/0 removes the stored tokens" do
+      assert :ok = Auth.save(@valid_attrs)
+      assert Auth.get_tokens()
+
+      assert :ok = Auth.delete_tokens()
+      assert Auth.get_tokens() == nil
+    end
+
+    test "delete_tokens/0 is a no-op when there are no tokens" do
+      assert Auth.get_tokens() == nil
+      assert :ok = Auth.delete_tokens()
+      assert Auth.get_tokens() == nil
+    end
   end
 end