defmodule Selecto.Performance.QueryCache do
@moduledoc """
High-performance query result caching for Selecto.
Provides intelligent caching of query results with:
- Automatic cache key generation from SQL and parameters
- TTL-based expiration
- Size-based eviction (LRU)
- Cache invalidation strategies
- Cache statistics and monitoring
- ETS-backed low-latency reads
"""
use GenServer
require Logger
@default_config %{
max_size: 1000,
default_ttl: :timer.minutes(5),
eviction_policy: :lru,
cache_backend: :ets,
track_stats: true,
compression: false,
# bytes
compression_threshold: 1024
}
@cache_table :selecto_query_cache
@stats_ref_table :selecto_cache_stats_ref
@counter_hits 1
@counter_misses 2
@counter_evictions 3
@counter_invalidations 4
@counter_item_count 5
@counter_size_bytes 6
defstruct [
:config,
:cache_table,
:stats_counter,
:lru_list,
:size_bytes,
:item_count
]
# Client API
@doc """
Start the query cache process.
## Options
- `:max_size` - Maximum number of cached queries (default: 1000)
- `:default_ttl` - Default TTL in milliseconds (default: 5 minutes)
- `:eviction_policy` - :lru, :lfu, or :ttl (default: :lru)
- `:cache_backend` - :ets (default: :ets)
- `:track_stats` - Enable cache statistics (default: true)
- `:compression` - Enable result compression (default: false)
"""
def start_link(opts \\ []) do
case GenServer.start_link(__MODULE__, opts, name: __MODULE__) do
{:ok, pid} -> {:ok, pid}
{:error, {:already_started, pid}} -> {:ok, pid}
other -> other
end
end
@doc """
Get a cached query result.
Returns {:ok, result} if found, :miss if not in cache.
"""
def get(cache_key) do
case fast_get(cache_key) do
:no_fast_path ->
call_if_running({:get, cache_key}, :miss)
result ->
result
end
end
@doc """
Store a query result in cache.
## Options
- `:ttl` - Override default TTL for this entry
- `:tags` - Tags for cache invalidation
- `:compress` - Force compression for this entry
"""
def put(cache_key, result, options \\ []) do
call_if_running({:put, cache_key, result, options}, :ok)
end
@doc """
Generate a cache key from Selecto query.
"""
def generate_key(selecto) do
try do
{sql, params} = Selecto.to_sql(selecto)
generate_key_from_sql(sql, params)
rescue
_ ->
:crypto.hash(:sha256, :erlang.term_to_binary(selecto))
|> Base.encode16(case: :lower)
end
end
@doc """
Generate a cache key from SQL and parameters.
"""
def generate_key_from_sql(sql, params) do
:crypto.hash(:sha256, :erlang.term_to_binary({sql, params}))
|> Base.encode16(case: :lower)
end
@doc """
Invalidate cache entries by key or pattern.
"""
def invalidate(key_or_pattern) do
call_if_running({:invalidate, key_or_pattern}, {:ok, 0})
end
@doc """
Invalidate cache entries by tags.
"""
def invalidate_by_tags(tags) when is_list(tags) do
call_if_running({:invalidate_by_tags, tags}, {:ok, 0})
end
@doc """
Clear entire cache.
"""
def clear do
call_if_running(:clear, :ok)
end
@doc """
Get cache statistics.
"""
def stats do
call_if_running(:stats, %{status: :not_started})
end
@doc """
Warm up cache with frequently used queries.
"""
def warmup(queries) when is_list(queries) do
call_if_running({:warmup, queries}, {:ok, 0})
end
@doc """
Execute a query with caching.
This is a convenience function that checks cache, executes if needed,
and caches the result.
"""
def cached_execute(selecto, execute_fn, options \\ []) do
cache_key = generate_key(selecto)
case get(cache_key) do
{:ok, cached_result} ->
# Record cache hit
record_hit(cache_key)
{:ok, cached_result}
:miss ->
# Execute query
case execute_fn.(selecto) do
{:ok, result} = success ->
# Cache the result
put(cache_key, result, options)
record_miss(cache_key)
success
error ->
error
end
end
end
defp fast_get(cache_key) do
case :ets.whereis(@cache_table) do
:undefined ->
:no_fast_path
table ->
case :ets.lookup(table, cache_key) do
[{^cache_key, entry}] ->
if expired?(entry) do
:no_fast_path
else
cast_if_running({:touch, cache_key})
update_stats_fast(:hits)
result =
if entry.compressed do
decompress_result(entry.result)
else
entry.result
end
{:ok, result}
end
[] ->
update_stats_fast(:misses)
:miss
end
end
end
defp call_if_running(request, fallback) do
case Process.whereis(__MODULE__) do
nil -> fallback
_pid -> GenServer.call(__MODULE__, request)
end
end
defp cast_if_running(request) do
case Process.whereis(__MODULE__) do
nil -> :ok
_pid -> GenServer.cast(__MODULE__, request)
end
end
defp update_stats_fast(key) do
case current_stats_counter() do
{:ok, counter} ->
:counters.add(counter, counter_index(key), 1)
:ok
:error ->
:ok
end
end
defp normalize_config(opts) do
config = Map.merge(@default_config, Map.new(opts))
%{config | cache_backend: normalize_cache_backend(Map.get(config, :cache_backend, :ets))}
end
defp normalize_cache_backend(:ets), do: :ets
defp normalize_cache_backend(other) do
Logger.warning(
"[Selecto.QueryCache] Unsupported cache backend #{inspect(other)}; falling back to :ets"
)
:ets
end
# Server Callbacks
@impl true
def init(opts) do
config = normalize_config(opts)
# Create cache table
cache_table = create_cache_table(config.cache_backend)
stats_counter =
if config.track_stats do
counter = :counters.new(6, [:write_concurrency])
register_stats_counter(counter)
counter
else
unregister_stats_counter()
nil
end
# Schedule TTL cleanup
if config.eviction_policy == :ttl do
schedule_ttl_cleanup()
end
{:ok,
%__MODULE__{
config: config,
cache_table: cache_table,
stats_counter: stats_counter,
lru_list: [],
size_bytes: 0,
item_count: 0
}}
end
@impl true
def handle_call({:get, cache_key}, _from, state) do
case lookup_cache(state.cache_table, cache_key) do
{:ok, entry} ->
# Check TTL
if expired?(entry) do
delete_from_cache(state.cache_table, cache_key)
increment_stat(state, :misses)
{:reply, :miss, state}
else
# Update LRU if needed
new_state =
if state.config.eviction_policy == :lru do
update_lru(state, cache_key)
else
state
end
touch_entry(state.cache_table, cache_key)
increment_stat(state, :hits)
# Decompress if needed
result =
if entry.compressed do
decompress_result(entry.result)
else
entry.result
end
{:reply, {:ok, result}, new_state}
end
:miss ->
increment_stat(state, :misses)
{:reply, :miss, state}
end
end
@impl true
def handle_call({:put, cache_key, result, options}, _from, state) do
{:reply, :ok, do_put(cache_key, result, options, state)}
end
@impl true
def handle_call({:invalidate, pattern}, _from, state) do
count = invalidate_pattern(state.cache_table, pattern)
new_state = %{state | item_count: max(0, state.item_count - count)}
increment_stat(new_state, :invalidations, count)
set_stat(new_state, :item_count, new_state.item_count)
{:reply, {:ok, count}, new_state}
end
@impl true
def handle_call({:invalidate_by_tags, tags}, _from, state) do
count = invalidate_by_tags_impl(state.cache_table, tags)
new_state = %{state | item_count: max(0, state.item_count - count)}
increment_stat(new_state, :invalidations, count)
set_stat(new_state, :item_count, new_state.item_count)
{:reply, {:ok, count}, new_state}
end
@impl true
def handle_call(:clear, _from, state) do
clear_cache(state.cache_table)
new_state = %{state | item_count: 0, size_bytes: 0, lru_list: []}
set_stat(new_state, :item_count, 0)
set_stat(new_state, :size_bytes, 0)
{:reply, :ok, new_state}
end
@impl true
def handle_call(:stats, _from, state) do
stats =
if state.stats_counter do
%{
hits: get_stat(state.stats_counter, :hits),
misses: get_stat(state.stats_counter, :misses),
evictions: get_stat(state.stats_counter, :evictions),
invalidations: get_stat(state.stats_counter, :invalidations),
size_bytes: get_stat(state.stats_counter, :size_bytes),
item_count: get_stat(state.stats_counter, :item_count)
}
|> Map.merge(%{
hit_rate: calculate_hit_rate(state.stats_counter),
avg_entry_size:
if(state.item_count > 0, do: state.size_bytes / state.item_count, else: 0),
memory_usage: state.size_bytes,
cache_size: state.item_count,
max_size: state.config.max_size
})
else
%{stats_disabled: true}
end
{:reply, stats, state}
end
@impl true
def handle_call({:warmup, queries}, _from, state) do
# Warm up cache with pre-computed queries
{warmed, new_state} =
Enum.reduce(queries, {0, state}, fn {selecto, result}, {count, acc_state} ->
cache_key = generate_key(selecto)
{count + 1, do_put(cache_key, result, [], acc_state)}
end)
{:reply, {:ok, warmed}, new_state}
end
@impl true
def handle_cast({:put, cache_key, result, options}, state) do
{:noreply, do_put(cache_key, result, options, state)}
end
@impl true
def handle_cast({:touch, cache_key}, state) do
touched_state =
if state.config.eviction_policy == :lru do
update_lru(state, cache_key)
else
state
end
touch_entry(state.cache_table, cache_key)
{:noreply, touched_state}
end
@impl true
def handle_info(:ttl_cleanup, state) do
# Remove expired entries
expired_count = cleanup_expired(state.cache_table)
new_state = %{state | item_count: max(0, state.item_count - expired_count)}
if expired_count > 0 do
increment_stat(new_state, :invalidations, expired_count)
set_stat(new_state, :item_count, new_state.item_count)
end
# Schedule next cleanup
schedule_ttl_cleanup()
{:noreply, new_state}
end
# Private functions - Cache Operations
defp do_put(cache_key, result, options, state) do
ttl = Keyword.get(options, :ttl, state.config.default_ttl)
tags = Keyword.get(options, :tags, [])
result_size = :erlang.external_size(result)
{final_result, compressed} =
if should_compress?(result_size, options, state.config) do
{compress_result(result), true}
else
{result, false}
end
now = System.monotonic_time(:millisecond)
entry = %{
result: final_result,
inserted_at: now,
ttl: ttl,
tags: tags,
size: result_size,
compressed: compressed,
access_count: 0,
last_accessed: now
}
existing_entry =
case lookup_cache(state.cache_table, cache_key) do
{:ok, existing} -> existing
:miss -> nil
end
state_after_evict =
if is_nil(existing_entry) and state.item_count >= state.config.max_size do
evict_entry(state)
else
state
end
insert_into_cache(state_after_evict.cache_table, cache_key, entry)
item_count_delta = if is_nil(existing_entry), do: 1, else: 0
previous_size = if is_nil(existing_entry), do: 0, else: existing_entry.size
new_state = %{
state_after_evict
| item_count: state_after_evict.item_count + item_count_delta,
size_bytes: max(0, state_after_evict.size_bytes + result_size - previous_size),
lru_list:
[cache_key | List.delete(state_after_evict.lru_list, cache_key)]
|> Enum.take(state.config.max_size)
}
set_stat(new_state, :item_count, new_state.item_count)
set_stat(new_state, :size_bytes, new_state.size_bytes)
new_state
end
defp create_cache_table(:ets) do
:ets.new(@cache_table, [
:set,
:public,
:named_table,
read_concurrency: true,
write_concurrency: true
])
end
defp create_cache_table(_backend), do: create_cache_table(:ets)
defp lookup_cache(table, key) when is_reference(table) or is_atom(table) do
case :ets.lookup(table, key) do
[{^key, entry}] -> {:ok, entry}
[] -> :miss
end
end
defp insert_into_cache(table, key, entry) when is_reference(table) or is_atom(table) do
:ets.insert(table, {key, entry})
end
defp delete_from_cache(table, key) when is_reference(table) or is_atom(table) do
:ets.delete(table, key)
end
defp clear_cache(table) when is_reference(table) or is_atom(table) do
:ets.delete_all_objects(table)
end
defp touch_entry(table, key) when is_reference(table) or is_atom(table) do
case :ets.lookup(table, key) do
[{^key, entry}] ->
updated = %{
entry
| access_count: Map.get(entry, :access_count, 0) + 1,
last_accessed: System.monotonic_time(:millisecond)
}
:ets.insert(table, {key, updated})
:ok
[] ->
:miss
end
end
# Private functions - Eviction
defp evict_entry(%{config: %{eviction_policy: :lru}} = state) do
# Remove least recently used
case List.last(state.lru_list) do
nil ->
state
oldest_key ->
delete_from_cache(state.cache_table, oldest_key)
increment_stat(state, :evictions)
%{
state
| lru_list: List.delete(state.lru_list, oldest_key),
item_count: state.item_count - 1
}
end
end
defp evict_entry(%{config: %{eviction_policy: :lfu}} = state) do
# Remove least frequently used
# This would require tracking access counts
evict_lfu_entry(state)
end
defp evict_entry(%{config: %{eviction_policy: :ttl}} = state) do
# Remove oldest by TTL
evict_oldest_entry(state)
end
defp evict_lfu_entry(state) do
# Find entry with lowest access count
case find_lfu_entry(state.cache_table) do
nil ->
state
{key, _entry} ->
delete_from_cache(state.cache_table, key)
increment_stat(state, :evictions)
%{state | lru_list: List.delete(state.lru_list, key), item_count: state.item_count - 1}
end
end
defp find_lfu_entry(table) when is_reference(table) or is_atom(table) do
:ets.foldl(
fn {key, entry}, acc ->
case acc do
nil ->
{key, entry}
{_min_key, min_entry} ->
if entry.access_count < min_entry.access_count do
{key, entry}
else
acc
end
end
end,
nil,
table
)
end
defp evict_oldest_entry(state) do
case find_oldest_entry(state.cache_table) do
nil ->
state
{key, _entry} ->
delete_from_cache(state.cache_table, key)
increment_stat(state, :evictions)
%{state | lru_list: List.delete(state.lru_list, key), item_count: state.item_count - 1}
end
end
defp find_oldest_entry(table) when is_reference(table) or is_atom(table) do
:ets.foldl(
fn {key, entry}, acc ->
case acc do
nil ->
{key, entry}
{_old_key, old_entry} ->
if entry.inserted_at < old_entry.inserted_at do
{key, entry}
else
acc
end
end
end,
nil,
table
)
end
# Private functions - LRU Management
defp update_lru(state, key) do
new_lru =
[key | List.delete(state.lru_list, key)]
|> Enum.take(state.config.max_size)
%{state | lru_list: new_lru}
end
# Private functions - TTL Management
defp expired?(%{inserted_at: inserted_at, ttl: ttl}) do
current_time = System.monotonic_time(:millisecond)
current_time > inserted_at + ttl
end
defp cleanup_expired(table) when is_reference(table) or is_atom(table) do
current_time = System.monotonic_time(:millisecond)
expired_keys =
:ets.foldl(
fn {key, entry}, acc ->
if current_time > entry.inserted_at + entry.ttl do
[key | acc]
else
acc
end
end,
[],
table
)
Enum.each(expired_keys, &:ets.delete(table, &1))
length(expired_keys)
end
defp schedule_ttl_cleanup do
Process.send_after(self(), :ttl_cleanup, :timer.minutes(1))
end
# Private functions - Invalidation
defp invalidate_pattern(table, pattern) when is_binary(pattern) do
# Pattern-based invalidation
regex =
pattern
|> String.replace("*", ".*")
|> Regex.compile!()
invalidate_matching(table, fn key ->
Regex.match?(regex, key)
end)
end
defp invalidate_pattern(table, key) do
# Direct key invalidation
delete_from_cache(table, key)
1
end
defp invalidate_matching(table, match_fn) when is_reference(table) or is_atom(table) do
keys_to_delete =
:ets.foldl(
fn {key, _entry}, acc ->
if match_fn.(key) do
[key | acc]
else
acc
end
end,
[],
table
)
Enum.each(keys_to_delete, &:ets.delete(table, &1))
length(keys_to_delete)
end
defp invalidate_by_tags_impl(table, tags) when is_reference(table) or is_atom(table) do
tag_set = MapSet.new(tags)
keys_to_delete =
:ets.foldl(
fn {key, entry}, acc ->
entry_tags = MapSet.new(entry.tags)
if MapSet.disjoint?(tag_set, entry_tags) do
acc
else
[key | acc]
end
end,
[],
table
)
Enum.each(keys_to_delete, &:ets.delete(table, &1))
length(keys_to_delete)
end
# Private functions - Compression
defp should_compress?(size, options, config) do
compress_override = Keyword.get(options, :compress)
cond do
compress_override == true -> true
compress_override == false -> false
config.compression && size >= config.compression_threshold -> true
true -> false
end
end
defp compress_result(result) do
:erlang.term_to_binary(result)
|> :zlib.compress()
end
defp decompress_result(compressed) do
compressed
|> :zlib.uncompress()
|> :erlang.binary_to_term([:safe])
end
@impl true
def terminate(_reason, _state) do
unregister_stats_counter()
:ok
end
# Private functions - Statistics
defp increment_stat(%{stats_counter: nil}, _key, _value), do: :ok
defp increment_stat(%{stats_counter: counter}, key, value) when is_integer(value) do
:counters.add(counter, counter_index(key), value)
:ok
end
defp increment_stat(state, key), do: increment_stat(state, key, 1)
defp set_stat(%{stats_counter: nil}, _key, _value), do: :ok
defp set_stat(%{stats_counter: counter}, key, value) when is_integer(value) and value >= 0 do
:counters.put(counter, counter_index(key), value)
:ok
end
defp get_stat(counter, key) do
:counters.get(counter, counter_index(key))
end
defp calculate_hit_rate(counter) do
hits = get_stat(counter, :hits)
misses = get_stat(counter, :misses)
total = hits + misses
if total > 0 do
Float.round(hits / total * 100, 2)
else
0.0
end
end
defp current_stats_counter do
case :ets.whereis(@stats_ref_table) do
:undefined ->
:error
table ->
case :ets.lookup(table, :counter) do
[{:counter, counter}] -> {:ok, counter}
[] -> :error
end
end
end
defp register_stats_counter(counter) do
table = ensure_stats_ref_table()
:ets.insert(table, {:counter, counter})
:ok
end
defp unregister_stats_counter do
case :ets.whereis(@stats_ref_table) do
:undefined -> :ok
table -> :ets.delete(table, :counter)
end
end
defp ensure_stats_ref_table do
case :ets.whereis(@stats_ref_table) do
:undefined ->
try do
:ets.new(@stats_ref_table, [
:set,
:public,
:named_table,
read_concurrency: true,
write_concurrency: true
])
rescue
ArgumentError -> :ets.whereis(@stats_ref_table)
end
table ->
table
end
end
defp counter_index(:hits), do: @counter_hits
defp counter_index(:misses), do: @counter_misses
defp counter_index(:evictions), do: @counter_evictions
defp counter_index(:invalidations), do: @counter_invalidations
defp counter_index(:item_count), do: @counter_item_count
defp counter_index(:size_bytes), do: @counter_size_bytes
defp record_hit(cache_key) do
:telemetry.execute([:selecto, :cache, :hit], %{count: 1}, %{key: cache_key})
end
defp record_miss(cache_key) do
:telemetry.execute([:selecto, :cache, :miss], %{count: 1}, %{key: cache_key})
end
end
