Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
Periodically refresh salts so that non-rotating nodes catch up (#5496)
Adam Rutkowskidad00d26c230
diff --git a/lib/plausible/session/salts.ex b/lib/plausible/session/salts.exindex 89bdf46a8a..78938ed713 100644--- a/lib/plausible/session/salts.ex+++ b/lib/plausible/session/salts.ex@@ -1,7 +1,6 @@defmodule Plausible.Session.Salts douse GenServeruse Plausible.Repo- require Loggerdef start_link(opts) doGenServer.start_link(__MODULE__, opts, name: opts[:name] || __MODULE__)@@ -9,8 +8,6 @@ defmodule Plausible.Session.Salts do@impl truedef init(opts) do- Process.flag(:trap_exit, true)-name = opts[:name] || __MODULE__now = opts[:now] || DateTime.utc_now()clean_old_salts(now)@@ -23,8 +20,13 @@ defmodule Plausible.Session.Salts do{:read_concurrency, true}])- salts =- Repo.all(from s in "salts", select: s.salt, order_by: [desc: s.inserted_at], limit: 2)+ refresh(name, now)++ {:ok, name}+ end++ def refresh(name, now) do+ salts = Repo.all(from s in "salts", select: s.salt, order_by: [desc: s.id], limit: 2)state =case salts do@@ -39,15 +41,20 @@ defmodule Plausible.Session.Salts do%{previous: nil, current: new}end- log_state("init", state)true = :ets.insert(name, {:state, state})- {:ok, name}+ Process.send_after(self(), {:refresh, now}, :timer.seconds(90))+ :okenddef rotate(name \\ __MODULE__, now \\ DateTime.utc_now()) doGenServer.call(name, {:rotate, now})end+ def fetch(name \\ __MODULE__) do+ [state: state] = :ets.lookup(name, :state)+ state+ end+@impl truedef handle_call({:rotate, now}, _from, name) docurrent = fetch(name).current@@ -59,20 +66,18 @@ defmodule Plausible.Session.Salts doprevious: current}- log_state("rotated", state)true = :ets.insert(name, {:state, state}){:reply, :ok, name}end- def fetch(name \\ __MODULE__) do- [state: state] = :ets.lookup(name, :state)-- state+ @impl true+ def handle_info({:refresh, now}, name) do+ refresh(name, now)+ {:noreply, name}enddefp generate_and_persist_new_salt(now) dosalt = :crypto.strong_rand_bytes(16)- Logger.warning("[salts] generated #{:erlang.phash2(salt)}")Repo.insert_all("salts", [%{salt: salt, inserted_at: now}])saltend@@ -83,17 +88,4 @@ defmodule Plausible.Session.Salts doRepo.delete_all(from s in "salts", where: s.inserted_at < ^h48_ago)end-- @impl true- def terminate(_reason, name) do- log_state("terminating", fetch(name))- end-- defp log_state(stage, state) do- %{current: current, previous: previous} = state-- Logger.warning(- "[salts] stage=#{stage} current=#{:erlang.phash2(current)} previous=#{:erlang.phash2(previous)}"- )- endenddiff --git a/test/plausible/session/salts_test.exs b/test/plausible/session/salts_test.exsindex 4e739bff07..25821ce38e 100644--- a/test/plausible/session/salts_test.exs+++ b/test/plausible/session/salts_test.exs@@ -20,15 +20,13 @@ defmodule Plausible.Session.SaltsTest doendtest "old salts can be cleaned" do- h30_ago =- DateTime.shift(DateTime.utc_now(), hour: -48)+ t1 = ~U[2025-06-10 15:29:40Z]- {:ok, _} = Salts.start_link(name: __MODULE__, now: h30_ago)+ {:ok, _} = Salts.start_link(name: __MODULE__, now: t1)- h24_ago =- DateTime.shift(DateTime.utc_now(), hour: -24)+ t2 = ~U[2025-06-11 15:29:40Z]- :ok = Salts.rotate(__MODULE__, h24_ago)+ :ok = Salts.rotate(__MODULE__, t2)%{current: old_current, previous: _old_previous} =Salts.fetch(__MODULE__)@@ -37,10 +35,9 @@ defmodule Plausible.Session.SaltsTest docount = Repo.aggregate(q, :count)assert count == 2- future =- DateTime.shift(DateTime.utc_now(), hour: 24, minute: 5)+ t3 = ~U[2025-06-13 15:34:40Z]- :ok = Salts.rotate(__MODULE__, future)+ :ok = Salts.rotate(__MODULE__, t3)%{current: _current, previous: ^old_current} =Salts.fetch(__MODULE__)@@ -49,4 +46,22 @@ defmodule Plausible.Session.SaltsTest docount = Repo.aggregate(q, :count)assert count == 2end++ test "salts refresh when another node rotates them" do+ t1 = ~U[2024-06-10 15:29:40Z]+ {:ok, _} = Salts.start_link(name: :node_1, now: t1)+ {:ok, _} = Salts.start_link(name: :node_2, now: t1)++ t2 = ~U[2024-06-11 15:29:40Z]++ :ok = Salts.rotate(:node_2, t2)++ assert Salts.fetch(:node_1) != Salts.fetch(:node_2)++ send(:node_1, {:refresh, t2})++ assert eventually(fn ->+ {Salts.fetch(:node_1) == Salts.fetch(:node_2), :ok}+ end)+ endend