mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-04 14:25:08 +00:00
refactor(web): one logging setup and one TTL cache for the web process (#621)
* refactor(web): use src.logging_config in the web process; routine requests to DEBUG
The web interface had its own logging setup (web_interface/logging_config.py)
that replaced the root handlers with a plain stdout formatter. The web
service's journal lines therefore never carried a syslog priority, so
`journalctl -p err -u ledmatrix-web` returned nothing while errors were
logged, and the line shape differed from the display's (the log viewer's
prefix stripping only matched the display format). It also ran after the
module-level managers were built, so their INFO lines at import (including
"Re-removed N uninstalled plugin(s)") were dropped.
app.py now calls src.logging_config.setup_logging() first thing, the same as
run.py: journald priorities under systemd, LEDMATRIX_DEBUG honoured,
LEDMATRIX_JSON_LOGGING still selects JSON.
Per-request logging moves to web_interface/request_logging.py. Every request
used to be logged at INFO, so the UI's polling filled the journal
("GET /api/v3/errors/summary - 200" every minute per tab). Now a successful
GET/HEAD/OPTIONS is DEBUG, a successful write is INFO, 4xx WARNING, 5xx
ERROR. Durations use perf_counter and print to 0.1ms.
The duplicate module is deleted; nothing else imported it.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* refactor(web): one thread-safe TTL cache for the web process
web_interface/cache.py becomes a small TTLCache class (lock-guarded,
monotonic clock) with the existing get_cached/set_cached/delete_cached/
invalidate_cache helpers kept on top of a shared instance, so the api_v3
callers are unchanged.
Bugs fixed:
- set_cached(ttl_seconds=...) ignored its TTL; only the reader's value
counted and get_cached defaulted to 60s. An entry now expires after the TTL
it was stored with; a reader's ttl_seconds can only shorten that. Both
current callers pass the same value on both sides (fonts_catalog 300s,
system_status 10s), so their observable TTLs are unchanged.
- get_cached deleted expired keys without a lock; two threads reading the
same expired key could raise KeyError (reproduced), which the endpoints
turned into a 500.
app.py's two hand-rolled systemctl caches (_ap_mode_cache, 30s, and
_ledmatrix_service_cache, 15s) now share one helper over a private
TTLCache, with the same TTLs. The AP-mode check used to retry on every
request after a failure (and log an ERROR each time); a failure now keeps the
last known answer for the TTL, as the display-service check already did. With
no systemctl at all (a dev machine) it answers False without forking.
Left alone as not TTL memoisation: the gzip cache (size-bounded, keyed by URL
and version), the settings search index (keyed by installed-plugin set), the
widget bundle (keyed by file fingerprint) and CacheManager (cross-process).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* docs(changelog): web logging and TTL cache
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(web): only ask systemctl about known units
Codacy flagged the systemctl argv built from a variable. The unit now has
to be one of two literals, and anything else raises.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
* fix(web): response_time_ms reads the same clock request_logging stamps
request_logging now stamps request.start_time from perf_counter, but
success_response still subtracted it from time.time(), so metadata
reported ~1.8e12 ms. Found testing on ledpi.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
+90
-31
@@ -1,48 +1,107 @@
|
||||
"""
|
||||
Simple in-memory cache for expensive operations.
|
||||
Separated from app.py to avoid circular import issues.
|
||||
In-process TTL cache for the web interface.
|
||||
|
||||
The one place the web process memoises cheap-to-recompute values for a few
|
||||
seconds or minutes (the font catalog, the system-status snapshot, systemctl
|
||||
checks). It is per-process and in-memory only; data shared with the display
|
||||
service goes through ``src.cache_manager.CacheManager`` instead.
|
||||
|
||||
Separated from app.py to avoid circular imports: blueprints import the
|
||||
module-level helpers below lazily, inside their request handlers.
|
||||
"""
|
||||
import threading
|
||||
import time
|
||||
from typing import Any, Optional
|
||||
from typing import Any, Callable, Dict, Optional, Tuple
|
||||
|
||||
|
||||
# Simple in-memory cache for expensive operations
|
||||
_cache = {}
|
||||
_cache_timestamps = {}
|
||||
class TTLCache:
|
||||
"""A small thread-safe key/value store whose entries expire.
|
||||
|
||||
Each entry keeps the TTL it was stored with. A reader may additionally
|
||||
pass ``max_age`` to ask for something fresher than that; an entry is only
|
||||
returned while it is younger than both.
|
||||
|
||||
Expired entries are not dropped on read: :meth:`peek` still returns them,
|
||||
which is what a "keep the last known answer if the refresh fails" caller
|
||||
needs. They are replaced by the next :meth:`set` of the same key, so this
|
||||
is meant for a small, fixed set of keys, not an unbounded key space.
|
||||
|
||||
Ages are measured with ``time.monotonic`` so a wall-clock jump (NTP sync
|
||||
on a Pi that booted without an RTC) neither expires nor immortalises
|
||||
everything at once.
|
||||
"""
|
||||
|
||||
def __init__(self, default_ttl: float = 60,
|
||||
clock: Callable[[], float] = time.monotonic):
|
||||
self._default_ttl = default_ttl
|
||||
self._clock = clock
|
||||
self._lock = threading.Lock()
|
||||
# key -> (value, stored_at, ttl)
|
||||
self._entries: Dict[str, Tuple[Any, float, float]] = {}
|
||||
|
||||
def get(self, key: str, default: Any = None,
|
||||
max_age: Optional[float] = None) -> Any:
|
||||
"""The value for ``key`` if it is still fresh, else ``default``."""
|
||||
with self._lock:
|
||||
entry = self._entries.get(key)
|
||||
if entry is None:
|
||||
return default
|
||||
value, stored_at, ttl = entry
|
||||
age = self._clock() - stored_at
|
||||
if age >= ttl or (max_age is not None and age >= max_age):
|
||||
return default
|
||||
return value
|
||||
|
||||
def peek(self, key: str, default: Any = None) -> Any:
|
||||
"""The last value stored for ``key``, fresh or not."""
|
||||
with self._lock:
|
||||
entry = self._entries.get(key)
|
||||
return default if entry is None else entry[0]
|
||||
|
||||
def set(self, key: str, value: Any, ttl: Optional[float] = None) -> None:
|
||||
"""Store ``value`` for ``ttl`` seconds (the cache default if None)."""
|
||||
ttl = self._default_ttl if ttl is None else ttl
|
||||
with self._lock:
|
||||
self._entries[key] = (value, self._clock(), ttl)
|
||||
|
||||
def delete(self, key: str) -> None:
|
||||
"""Remove ``key`` if present."""
|
||||
with self._lock:
|
||||
self._entries.pop(key, None)
|
||||
|
||||
def clear(self, pattern: Optional[str] = None) -> None:
|
||||
"""Remove every entry, or only those whose key contains ``pattern``."""
|
||||
with self._lock:
|
||||
if pattern is None:
|
||||
self._entries.clear()
|
||||
else:
|
||||
for key in [k for k in self._entries if pattern in k]:
|
||||
del self._entries[key]
|
||||
|
||||
|
||||
def get_cached(key: str, ttl_seconds: int = 60) -> Optional[Any]:
|
||||
"""Get value from cache if not expired."""
|
||||
if key in _cache:
|
||||
if time.time() - _cache_timestamps[key] < ttl_seconds:
|
||||
return _cache[key]
|
||||
else:
|
||||
# Expired, remove
|
||||
del _cache[key]
|
||||
del _cache_timestamps[key]
|
||||
return None
|
||||
# The shared cache behind the functional helpers the blueprints use.
|
||||
_default_cache = TTLCache(default_ttl=60)
|
||||
|
||||
|
||||
def set_cached(key: str, value: Any, ttl_seconds: int = 60) -> None:
|
||||
"""Set value in cache with TTL."""
|
||||
_cache[key] = value
|
||||
_cache_timestamps[key] = time.time()
|
||||
def get_cached(key: str, ttl_seconds: Optional[float] = None) -> Optional[Any]:
|
||||
"""Get a value from the cache if it has not expired.
|
||||
|
||||
The entry expires after the TTL it was stored with; ``ttl_seconds``, when
|
||||
given, is an extra upper bound on its age for this read.
|
||||
"""
|
||||
return _default_cache.get(key, max_age=ttl_seconds)
|
||||
|
||||
|
||||
def set_cached(key: str, value: Any, ttl_seconds: float = 60) -> None:
|
||||
"""Store a value in the cache for ``ttl_seconds``."""
|
||||
_default_cache.set(key, value, ttl=ttl_seconds)
|
||||
|
||||
|
||||
def delete_cached(key: str) -> None:
|
||||
"""Remove a single key from the cache if present."""
|
||||
_cache.pop(key, None)
|
||||
_cache_timestamps.pop(key, None)
|
||||
_default_cache.delete(key)
|
||||
|
||||
|
||||
def invalidate_cache(pattern: Optional[str] = None) -> None:
|
||||
"""Invalidate cache entries matching pattern, or all if pattern is None."""
|
||||
if pattern is None:
|
||||
_cache.clear()
|
||||
_cache_timestamps.clear()
|
||||
else:
|
||||
keys_to_remove = [k for k in _cache.keys() if pattern in k]
|
||||
for key in keys_to_remove:
|
||||
del _cache[key]
|
||||
del _cache_timestamps[key]
|
||||
|
||||
_default_cache.clear(pattern)
|
||||
|
||||
Reference in New Issue
Block a user