defmodule Plausible.Site.CacheTest do use Plausible.DataCase, async: true alias Plausible.Site alias Plausible.Site.Cache import ExUnit.CaptureLog describe "public cache interface" do test "cache process is started, but falls back to the database if cache is disabled" do insert(:site, domain: "example.test") refute Cache.enabled?() assert Process.alive?(Process.whereis(Cache.name())) refute Process.whereis(Cache.Warmer) assert %Site{domain: "example.test", from_cache?: false} = Cache.get("example.test") assert Cache.size() == 0 refute Cache.get("other.test") end test "critical cache errors are logged and nil is returned" do log = capture_log(fn -> assert Cache.get("key", force?: true, cache_name: NonExistingCache) == nil end) assert log =~ "Error retrieving domain from 'NonExistingCache': :no_cache" end test "cache caches", %{test: test} do {:ok, _} = Supervisor.start_link([{Cache, [cache_name: test, child_id: :test_cache_caches_id]}], strategy: :one_for_one, name: Test.Supervisor.Cache ) %{id: first_id} = site1 = insert(:site, domain: "site1.example.com") _ = insert(:site, domain: "site2.example.com") :ok = Cache.refresh_all(cache_name: test) {:ok, _} = Plausible.Repo.delete(site1) assert Cache.size(test) == 2 assert %Site{from_cache?: true, id: ^first_id} = Cache.get("site1.example.com", force?: true, cache_name: test) assert %Site{from_cache?: true} = Cache.get("site2.example.com", force?: true, cache_name: test) assert %Site{from_cache?: false} = Cache.get("site2.example.com", cache_name: test) refute Cache.get("site3.example.com", cache_name: test, force?: true) end test "cache is ready when no sites exist in the db", %{test: test} do {:ok, _} = start_test_cache(test) assert Cache.ready?(test) end test "cache is not ready when sites exist in the db but cache needs refresh", %{test: test} do {:ok, _} = start_test_cache(test) insert(:site) refute Cache.ready?(test) end test "cache is ready when refreshed", %{test: test} do {:ok, _} = start_test_cache(test) insert(:site) :ok = Cache.refresh_all(cache_name: test) assert Cache.ready?(test) end test "cache exposes hit rate", %{test: test} do {:ok, _} = start_test_cache(test) insert(:site, domain: "site1.example.com") :ok = Cache.refresh_all(cache_name: test) assert Cache.hit_rate(test) == 0 assert Cache.get("site1.example.com", force?: true, cache_name: test) assert Cache.hit_rate(test) == 100 refute Cache.get("nonexisting.example.com", force?: true, cache_name: test) assert Cache.hit_rate(test) == 50 end test "only recently updated sites can be refreshed", %{test: test} do {:ok, _} = start_test_cache(test) domain1 = "site1.example.com" domain2 = "nonexisting.example.com" cache_opts = [cache_name: test, force?: true] yesterday = DateTime.utc_now() |> DateTime.add(-1 * 60 * 60 * 24) insert(:site, domain: domain1, inserted_at: yesterday, updated_at: yesterday) insert(:site, domain: domain2) assert Cache.get(domain1, cache_opts) == nil assert Cache.get(domain2, cache_opts) == nil assert :ok = Cache.refresh_updated_recently(cache_opts) refute Cache.get(domain1, cache_opts) assert %Site{domain: ^domain2} = Cache.get(domain2, cache_opts) end test "refreshing all sites sends a telemetry event", %{ test: test } do domain = "site1.example.com" insert(:site, domain: domain) :ok = start_test_cache_with_telemetry_handler(test, event: Cache.telemetry_event_refresh(test, :all) ) Cache.refresh_all(force?: true, cache_name: test) assert_receive {:telemetry_handled, %{}} end test "get_site_id/2", %{test: test} do {:ok, _} = start_test_cache(test) site = insert(:site) domain1 = site.domain domain2 = "nonexisting.example.com" :ok = Cache.refresh_all(cache_name: test) assert site.id == Cache.get_site_id(domain1, force?: true, cache_name: test) assert is_nil(Cache.get_site_id(domain2, force?: true, cache_name: test)) end end describe "warming the cache" do test "cache warmer process warms up the cache", %{test: test} do test_pid = self() opts = [force_start?: true, warmer_fn: report_back(test_pid), cache_name: test] {:ok, _} = Supervisor.start_link([{Cache.Warmer, opts}], strategy: :one_for_one, name: test) assert Process.whereis(Cache.Warmer) assert_receive {:cache_warmed, %{opts: got_opts}} assert got_opts[:cache_name] == test end test "cache warmer warms periodically with an interval", %{test: test} do test_pid = self() opts = [ force_start?: true, warmer_fn: report_back(test_pid), cache_name: test, interval: 30 ] {:ok, _} = start_test_warmer(opts) assert_receive {:cache_warmed, %{at: at1}}, 100 assert_receive {:cache_warmed, %{at: at2}}, 100 assert_receive {:cache_warmed, %{at: at3}}, 100 assert is_integer(at1) assert is_integer(at2) assert is_integer(at3) assert at1 < at2 assert at3 > at2 end test "deleted sites don't stay in cache on another refresh", %{test: test} do {:ok, _} = start_test_cache(test) domain1 = "site1.example.com" domain2 = "site2.example.com" site1 = insert(:site, domain: domain1) _site2 = insert(:site, domain: domain2) cache_opts = [cache_name: test, force?: true] :ok = Cache.refresh_all(cache_opts) assert Cache.get(domain1, cache_opts) assert Cache.get(domain2, cache_opts) Repo.delete!(site1) :ok = Cache.refresh_all(cache_opts) assert Cache.get(domain2, cache_opts) refute Cache.get(domain1, cache_opts) :ok = Cache.refresh_all(cache_opts) refute Cache.get(domain1, cache_opts) end end describe "merging the cache" do test "merging adds new items", %{test: test} do {:ok, _} = start_test_cache(test) :ok = Cache.merge([{"item1", :item1}], cache_name: test) assert :item1 == Cache.get("item1", cache_name: test, force?: true) end test "merging no new items leaves the old cache intact", %{test: test} do {:ok, _} = start_test_cache(test) :ok = Cache.merge([{"item1", :item1}], cache_name: test) :ok = Cache.merge([], cache_name: test) assert :item1 == Cache.get("item1", cache_name: test, force?: true) end test "merging removes stale items", %{test: test} do {:ok, _} = start_test_cache(test) :ok = Cache.merge([{"item1", :item1}], cache_name: test) :ok = Cache.merge([{"item2", :item2}], cache_name: test) refute Cache.get("item1", cache_name: test, force?: true) assert Cache.get("item2", cache_name: test, force?: true) end test "merging optionally leaves stale items intact", %{test: test} do {:ok, _} = start_test_cache(test) :ok = Cache.merge([{"item1", :item1}], cache_name: test) :ok = Cache.merge([{"item2", :item2}], cache_name: test, delete_stale_items?: false) assert Cache.get("item1", cache_name: test, force?: true) assert Cache.get("item2", cache_name: test, force?: true) end test "merging updates changed items", %{test: test} do {:ok, _} = start_test_cache(test) :ok = Cache.merge([{"item1", :item1}, {"item2", :item2}], cache_name: test) :ok = Cache.merge([{"item1", :changed}, {"item2", :item2}], cache_name: test) assert :changed == Cache.get("item1", cache_name: test, force?: true) assert :item2 == Cache.get("item2", cache_name: test, force?: true) end @items1 for i <- 1..200_000, do: {i, :batch1} @items2 for _ <- 1..200_000, do: {Enum.random(1..400_000), :batch2} @max_seconds 2 test "merging large sets is expected to be under #{@max_seconds} seconds", %{test: test} do {:ok, _} = start_test_cache(test) {t1, :ok} = :timer.tc(fn -> :ok = Cache.merge(@items1, cache_name: test) end) {t2, :ok} = :timer.tc(fn -> :ok = Cache.merge(@items1, cache_name: test) end) {t3, :ok} = :timer.tc(fn -> :ok = Cache.merge(@items2, cache_name: test) end) assert t1 / 1_000_000 <= @max_seconds assert t2 / 1_000_000 <= @max_seconds assert t3 / 1_000_000 <= @max_seconds end end defp report_back(test_pid) do fn opts -> send(test_pid, {:cache_warmed, %{at: System.monotonic_time(), opts: opts}}) :ok end end defp start_test_cache(cache_name) do %{start: {m, f, a}} = Cache.child_spec(cache_name: cache_name) apply(m, f, a) end defp start_test_warmer(opts) do child_name_opt = {:child_name, Keyword.fetch!(opts, :cache_name)} %{start: {m, f, a}} = Cache.Warmer.child_spec([child_name_opt | opts]) apply(m, f, a) end defp start_test_cache_with_telemetry_handler(test, event: event) do {:ok, _} = start_test_cache(test) test_pid = self() :telemetry.attach( "#{test}-telemetry-handler", event, fn ^event, %{duration: d}, metadata, _ when is_integer(d) -> send(test_pid, {:telemetry_handled, metadata}) end, %{} ) end end