Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Speed up salts lookup by serving them off ets (#5067)

hq1417e996c1afd
diff --git a/lib/plausible/session/salts.ex b/lib/plausible/session/salts.ex
index ba2066424f..a088b8ea8c 100644
--- a/lib/plausible/session/salts.ex
+++ b/lib/plausible/session/salts.ex
@@ -1,56 +1,81 @@
defmodule Plausible.Session.Salts do
- use Agent
+ use GenServer
use Plausible.Repo
- def start_link(_opts) do
- Agent.start_link(
- fn ->
- clean_old_salts()
+ def start_link(opts) do
+ GenServer.start_link(__MODULE__, opts, name: opts[:name] || __MODULE__)
+ end
+
+ @impl true
+ def init(opts) do
+ name = opts[:name] || __MODULE__
+ now = opts[:now] || DateTime.utc_now()
+ clean_old_salts(now)
+
+ ^name =
+ :ets.new(name, [
+ :named_table,
+ :set,
+ :protected,
+ {:read_concurrency, true}
+ ])
- salts =
- Repo.all(from s in "salts", select: s.salt, order_by: [desc: s.inserted_at], limit: 2)
+ salts =
+ Repo.all(from s in "salts", select: s.salt, order_by: [desc: s.inserted_at], limit: 2)
- case salts do
- [current, prev] ->
- %{previous: prev, current: current}
+ state =
+ case salts do
+ [current, prev] ->
+ %{previous: prev, current: current}
- [current] ->
- %{previous: nil, current: current}
+ [current] ->
+ %{previous: nil, current: current}
- [] ->
- new = generate_and_persist_new_salt()
- %{previous: nil, current: new}
- end
- end,
- name: __MODULE__
- )
+ [] ->
+ new = generate_and_persist_new_salt(now)
+ %{previous: nil, current: new}
+ end
+
+ true = :ets.insert(name, {:state, state})
+ {:ok, name}
end
- def fetch() do
- Agent.get(__MODULE__, & &1)
+ def rotate(name \\ __MODULE__, now \\ DateTime.utc_now()) do
+ GenServer.call(name, {:rotate, now})
end
- def rotate() do
- Agent.update(__MODULE__, fn %{current: current} ->
- clean_old_salts()
+ @impl true
+ def handle_call({:rotate, now}, _from, name) do
+ current = fetch(name).current
+ clean_old_salts(now)
+ state =
%{
- current: generate_and_persist_new_salt(),
+ current: generate_and_persist_new_salt(now),
previous: current
}
- end)
+
+ true = :ets.insert(name, {:state, state})
+ {:reply, :ok, name}
end
- defp generate_and_persist_new_salt() do
+ def fetch(name \\ __MODULE__) do
+ [state: state] = :ets.lookup(name, :state)
+
+ state
+ end
+
+ defp generate_and_persist_new_salt(now) do
salt = :crypto.strong_rand_bytes(16)
- Repo.insert_all("salts", [%{salt: salt, inserted_at: DateTime.utc_now()}])
+ Repo.insert_all("salts", [%{salt: salt, inserted_at: now}])
salt
end
- defp clean_old_salts() do
- Repo.delete_all(
- from s in "salts", where: s.inserted_at < fragment("now() - '48 hours'::interval")
- )
+ defp clean_old_salts(now) do
+ h48_ago =
+ DateTime.shift(now, hour: -48)
+
+ Repo.delete_all(from s in "salts", where: s.inserted_at < ^h48_ago)
end
end
diff --git a/test/plausible/session/salts_test.exs b/test/plausible/session/salts_test.exs
new file mode 100644
index 0000000000..4e739bff07
--- /dev/null
+++ b/test/plausible/session/salts_test.exs
@@ -0,0 +1,52 @@
+defmodule Plausible.Session.SaltsTest do
+ use Plausible.DataCase, async: false
+
+ alias Plausible.Session.Salts
+ import Ecto.Query
+
+ test "agent starts and responds with current salt" do
+ {:ok, _} = Salts.start_link(name: __MODULE__)
+ %{current: current, previous: nil} = Salts.fetch(__MODULE__)
+ assert is_binary(current)
+ end
+
+ test "agent starts and responds with current and previous salt after rotation" do
+ {:ok, _} = Salts.start_link(name: __MODULE__)
+ %{current: first, previous: nil} = Salts.fetch(__MODULE__)
+ :ok = Salts.rotate(__MODULE__)
+
+ %{current: current, previous: ^first} = Salts.fetch(__MODULE__)
+ assert is_binary(current)
+ end
+
+ test "old salts can be cleaned" do
+ h30_ago =
+ DateTime.shift(DateTime.utc_now(), hour: -48)
+
+ {:ok, _} = Salts.start_link(name: __MODULE__, now: h30_ago)
+
+ h24_ago =
+ DateTime.shift(DateTime.utc_now(), hour: -24)
+
+ :ok = Salts.rotate(__MODULE__, h24_ago)
+
+ %{current: old_current, previous: _old_previous} =
+ Salts.fetch(__MODULE__)
+
+ q = from(s in "salts")
+ count = Repo.aggregate(q, :count)
+ assert count == 2
+
+ future =
+ DateTime.shift(DateTime.utc_now(), hour: 24, minute: 5)
+
+ :ok = Salts.rotate(__MODULE__, future)
+
+ %{current: _current, previous: ^old_current} =
+ Salts.fetch(__MODULE__)
+
+ q = from(s in "salts")
+ count = Repo.aggregate(q, :count)
+ assert count == 2
+ end
+end