fix: invalidate cache on any Tenant update

Author: edgurgel

lib/realtime/api.ex

@@ -6,6 +6,7 @@ defmodule Realtime.Api do
 
   import Ecto.Query
 
+  alias Ecto.Changeset
   alias Realtime.Api.Extensions
   alias Realtime.Api.Tenant
   alias Realtime.GenCounter
@@ -198,7 +199,7 @@ defmodule Realtime.Api do
       new_settings = Map.put(settings, to, value)
 
       extension
-      |> Ecto.Changeset.cast(%{settings: new_settings}, [:settings])
+      |> Changeset.cast(%{settings: new_settings}, [:settings])
       |> Repo.update!()
     end
   end
@@ -222,23 +223,21 @@ defmodule Realtime.Api do
     |> Map.put(:events_per_second_now, current)
   end
 
-  defp maybe_invalidate_cache(
-         %Ecto.Changeset{changes: changes, valid?: true, data: %{external_id: external_id}} = changeset
-       )
-       when changes != %{} and requires_restarting_db_connection(changeset) do
+  defp maybe_invalidate_cache(%Changeset{changes: changes, valid?: true, data: %{external_id: external_id}})
+       when changes != %{} do
     Tenants.Cache.distributed_invalidate_tenant_cache(external_id)
   end
 
   defp maybe_invalidate_cache(_changeset), do: nil
 
-  defp maybe_trigger_disconnect(%Ecto.Changeset{data: %{external_id: external_id}} = changeset)
+  defp maybe_trigger_disconnect(%Changeset{data: %{external_id: external_id}} = changeset)
        when requires_disconnect(changeset) do
     SocketDisconnect.distributed_disconnect(external_id)
   end
 
   defp maybe_trigger_disconnect(_changeset), do: nil
 
-  defp maybe_restart_db_connection(%Ecto.Changeset{data: %{external_id: external_id}} = changeset)
+  defp maybe_restart_db_connection(%Changeset{data: %{external_id: external_id}} = changeset)
        when requires_restarting_db_connection(changeset) do
     Connect.shutdown(external_id)
   end

mix.exs

@@ -4,7 +4,7 @@ defmodule Realtime.MixProject do
   def project do
     [
       app: :realtime,
-      version: "2.57.5",
+      version: "2.57.6",
       elixir: "~> 1.18",
       elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,

test/realtime/api_test.exs

@@ -214,7 +214,7 @@ defmodule Realtime.ApiTest do
     end
 
     test "valid data and no changes to tenant will not refresh cache", %{tenant: tenant} do
-      reject(&Realtime.Tenants.Cache.get_tenant_by_external_id/1)
+      reject(&Realtime.Tenants.Cache.distributed_invalidate_tenant_cache/1)
       assert {:ok, %Tenant{}} = Api.update_tenant(tenant, %{name: tenant.name})
     end
   end

test/realtime/tenants/cache_test.exs

@@ -1,11 +1,11 @@
 defmodule Realtime.Tenants.CacheTest do
-  alias Realtime.Rpc
   # async: false due to the usage of dev_realtime tenant
   use Realtime.DataCase, async: false
 
   alias Realtime.Api
-  alias Realtime.Tenants.Cache
+  alias Realtime.Rpc
   alias Realtime.Tenants
+  alias Realtime.Tenants.Cache
 
   setup do
     {:ok, tenant: tenant_fixture()}
@@ -15,7 +15,9 @@ defmodule Realtime.Tenants.CacheTest do
     test "tenants cache returns a cached result", %{tenant: tenant} do
       external_id = tenant.external_id
       assert %Api.Tenant{name: "tenant"} = Cache.get_tenant_by_external_id(external_id)
-      Api.update_tenant(tenant, %{name: "new name"})
+
+      changeset = Api.Tenant.changeset(tenant, %{name: "new name"})
+      Repo.update!(changeset)
       assert %Api.Tenant{name: "new name"} = Tenants.get_tenant_by_external_id(external_id)
       assert %Api.Tenant{name: "tenant"} = Cache.get_tenant_by_external_id(external_id)
     end