You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
analytics/lib/plausible/site/cache/warmer.ex

86 lines
2.5 KiB
Elixir

defmodule Plausible.Site.Cache.Warmer do
@moduledoc """
A periodic cache warmer.
Queries all Sites from Postgres, every `interval` and pre-populates the cache.
After each run the process is hibernated, triggering garbage collection.
Currently Cachex is used, but the underlying implementation can be transparently swapped.
Child specification options available:
* `interval` - the number of milliseconds for each warm-up cycle, defaults
to `:sites_by_domain_cache_refresh_interval` application env value
with random jitter added, for which the maximum is stored under
`:sites_by_domain_cache_refresh_interval_max_jitter` key.
* `cache_name` - defaults to Cache.name() but can be overriden for testing
* `force_start?` - enforcess process startup for testing, even if it's barred
by `Cache.enabled?`. This is useful for avoiding issues with DB ownership
and async tests.
* `warmer_fn` - used for testing, a custom function to retrieve the items meant
to be cached during the warm-up cycle.
See tests for more comprehensive examples.
"""
@behaviour :gen_cycle
require Logger
alias Plausible.Site.Cache
@spec child_spec(Keyword.t()) :: Supervisor.child_spec() | :ignore
def child_spec(opts) do
child_name = Keyword.get(opts, :child_name, __MODULE__)
%{
id: child_name,
start: {:gen_cycle, :start_link, [{:local, child_name}, __MODULE__, opts]}
}
end
@impl true
def init_cycle(opts) do
interval = Keyword.get(opts, :interval, interval())
force_start? = Keyword.get(opts, :force_start?, false)
cache_name = Keyword.get(opts, :cache_name, Cache.name())
if Cache.enabled?() or force_start? do
Logger.info("Initializing #{__MODULE__} with interval #{interval}")
{:ok, {interval, Keyword.put(opts, :cache_name, cache_name)}}
else
:ignore
end
end
@impl true
def handle_cycle(opts) do
cache_name = Keyword.fetch!(opts, :cache_name)
Logger.info("Refreshing #{cache_name} cache...")
warmer_fn = Keyword.get(opts, :warmer_fn, &Cache.refresh_all/1)
warmer_fn.(opts)
{:continue_hibernated, opts}
end
@impl true
def handle_info(_msg, state) do
{:continue, state}
end
@spec interval() :: pos_integer()
def interval() do
interval = Application.fetch_env!(:plausible, :sites_by_domain_cache_refresh_interval)
interval + jitter()
end
defp jitter() do
max_jitter =
Application.fetch_env!(:plausible, :sites_by_domain_cache_refresh_interval_max_jitter)
Enum.random(1..max_jitter)
end
end