Public changes compared with the previous published export: 89 files changed. Affected areas: - backend/app: 21 files - dependencies: 5 files - deployment and CI: 6 files - documentation: 2 files - frontend: 3 files - frontend/src: 20 files - project files: 1 file - tests: 30 files - unraid: 1 file Changed files: - Updated: ".env.example" - Updated: "Dockerfile.unraid" - Updated: "README.md" - Updated: "backend/Dockerfile" - Added: "backend/app/alerts.py" - Updated: "backend/app/auth.py" - Added: "backend/app/backups.py" - Updated: "backend/app/config_io.py" - Updated: "backend/app/demo.py" - Updated: "backend/app/discovery.py" - Updated: "backend/app/discovery_store.py" - Updated: "backend/app/docker_discovery.py" - Updated: "backend/app/events.py" - Updated: "backend/app/evidence.py" - Updated: "backend/app/health.py" - Updated: "backend/app/incidents.py" - Added: "backend/app/loops.py" - Updated: "backend/app/main.py" - Updated: "backend/app/models.py" - Updated: "backend/app/observation.py" - Updated: "backend/app/probes.py" - Added: "backend/app/response_cache.py" - Updated: "backend/app/scheduler.py" - Updated: "backend/app/semantic.py" - Updated: "backend/app/store.py" - Updated: "backend/pyproject.toml" - Updated: "backend/tests/test_api.py" - Updated: "backend/tests/test_config_io.py" - Updated: "backend/tests/test_demo.py" - Updated: "backend/tests/test_discovery_v120.py" - Updated: "backend/tests/test_health.py" - Updated: "backend/tests/test_probes.py" - Updated: "backend/tests/test_scheduler.py" - Updated: "backend/tests/test_v130_probe_reachability.py" - Updated: "backend/tests/test_v160_evidence_changes.py" - Added: "backend/tests/test_v163_alerts.py" - Added: "backend/tests/test_v163_backups.py" - Added: "backend/tests/test_v163_data_integrity.py" - Added: "backend/tests/test_v163_efficiency.py" - Added: "backend/tests/test_v163_health_performance.py" - Added: "backend/tests/test_v163_loops.py" - Added: "backend/tests/test_v163_management.py" - Added: "backend/tests/test_v163_realtime.py" - Added: "backend/tests/test_v163_security.py" - Added: "backend/tests/test_v163_semantic_etag.py" - Added: "compose.demo.yaml" - Updated: "compose.yaml" - Added: "docker-compose.broker.yml" - Updated: "docker-compose.yml" - Updated: "docs/ARCHITECTURE.md" - Added: "frontend/e2e/a11y.spec.ts" - Updated: "frontend/e2e/demo.spec.ts" - Updated: "frontend/index.html" - Updated: "frontend/nginx.conf" - Updated: "frontend/package-lock.json" - Updated: "frontend/package.json" - Updated: "frontend/playwright.config.ts" - Updated: "frontend/src/App.tsx" - Updated: "frontend/src/LivingEdge.tsx" - Added: "frontend/src/activityView.test.ts" - Added: "frontend/src/activityView.ts" - Updated: "frontend/src/api.ts" - Added: "frontend/src/apiAuth.test.ts" - Added: "frontend/src/components/ActionsMenu.tsx" - Added: "frontend/src/components/ConfirmDialog.test.tsx" - Added: "frontend/src/components/ConfirmDialog.tsx" - Added: "frontend/src/components/StatusIcon.tsx" - Updated: "frontend/src/demo/DemoWalkthrough.test.ts" - Updated: "frontend/src/demo/DemoWalkthrough.tsx" - Added: "frontend/src/elk-worker-url.d.ts" - Added: "frontend/src/labels.ts" - Updated: "frontend/src/main.tsx" - Added: "frontend/src/realtime/refreshPlan.test.ts" - Added: "frontend/src/realtime/refreshPlan.ts" - Updated: "frontend/src/realtime/useRealtimeEvents.ts" - Added: "frontend/src/routing/urlState.test.ts" - Added: "frontend/src/routing/urlState.ts" - Updated: "frontend/src/styles.css" - Added: "frontend/src/topology/GraphListView.test.tsx" - Added: "frontend/src/topology/GraphListView.tsx" - Updated: "frontend/src/topology/ServiceNode.tsx" - Updated: "frontend/src/topology/TopologyCommandBar.tsx" - Added: "frontend/src/topology/semanticGraph.test.ts" - Updated: "frontend/src/topology/semanticGraph.ts" - Added: "frontend/src/topologyLayout.test.ts" - Updated: "frontend/src/topologyLayout.ts" - Updated: "package-lock.json" - Updated: "package.json" - Updated: "unraid/my-servicemap.xml" Export provenance/manifests refreshed; excluded from the change summary. Publish curated ServiceMap source from af46f684e468dffd3a5190e28d3b572d4c26bfd7
125 lines
4.3 KiB
Python
125 lines
4.3 KiB
Python
"""Validated, briefly cached JSON representations for hot read endpoints.
|
|
|
|
The semantic topology is read by the UI after every event burst and by
|
|
integrations such as ITWorx Forge on a fixed poll. Its content changes far
|
|
less often than it is read: in production only ``generated_at`` differed
|
|
between polls. Two mechanisms make an unchanged read nearly free:
|
|
|
|
* A strong ``ETag`` computed over the content *excluding* ``generated_at``.
|
|
A client that sends ``If-None-Match`` gets ``304 Not Modified`` with no
|
|
body. Because the tag is derived from the content itself it is always
|
|
correct, including after writes that publish no event.
|
|
* A short-lived computation cache. It is reused only while no event has
|
|
been published since it was built, no evidence freshness boundary
|
|
(fresh→stale→expired) has been crossed, and it is younger than
|
|
``max_age_seconds``. The age cap bounds staleness for the few write paths
|
|
that publish no event (for example discovery relation evidence).
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import hashlib
|
|
import time
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from datetime import datetime, timedelta
|
|
from threading import Lock
|
|
|
|
from pydantic import BaseModel
|
|
|
|
from .models import HealthEvidence
|
|
|
|
GENERATED_AT_HEADER = "X-ServiceMap-Generated-At"
|
|
|
|
|
|
@dataclass(frozen=True)
|
|
class CachedRepresentation:
|
|
body: bytes
|
|
etag: str
|
|
generated_at: str
|
|
|
|
|
|
def representation(model: BaseModel, *, timestamp_field: str = "generated_at") -> CachedRepresentation:
|
|
"""Serialize once and tag the content independent of its timestamp."""
|
|
|
|
content = model.model_dump_json(exclude={timestamp_field})
|
|
stamp = model.model_dump_json(include={timestamp_field})
|
|
# Splice ``{"generated_at": ...}`` in front of the remaining fields: one
|
|
# serialization for the body, the hash covers everything but the stamp.
|
|
body = stamp if content == "{}" else f"{stamp[:-1]},{content[1:]}"
|
|
digest = hashlib.sha256(content.encode()).hexdigest()[:32]
|
|
generated_at = str(getattr(model, timestamp_field).isoformat())
|
|
return CachedRepresentation(body=body.encode(), etag=f'"{digest}"', generated_at=generated_at)
|
|
|
|
|
|
def etag_matches(if_none_match: str | None, etag: str) -> bool:
|
|
if not if_none_match:
|
|
return False
|
|
for candidate in if_none_match.split(","):
|
|
value = candidate.strip()
|
|
if value == "*" or value.removeprefix("W/") == etag:
|
|
return True
|
|
return False
|
|
|
|
|
|
def next_freshness_boundary(evidence: list[HealthEvidence], now: datetime) -> datetime | None:
|
|
"""Earliest future instant at which any claim changes freshness."""
|
|
|
|
boundary: datetime | None = None
|
|
for item in evidence:
|
|
ttl = max(item.valid_until - item.observed_at, timedelta(seconds=1))
|
|
for instant in (item.valid_until, item.valid_until + ttl):
|
|
if instant > now and (boundary is None or instant < boundary):
|
|
boundary = instant
|
|
return boundary
|
|
|
|
|
|
@dataclass
|
|
class _Entry:
|
|
value: CachedRepresentation
|
|
revision: int
|
|
expires_at: float
|
|
|
|
|
|
class RepresentationCache:
|
|
"""Thread-safe cache keyed by request variant and event revision."""
|
|
|
|
def __init__(
|
|
self,
|
|
*,
|
|
max_age_seconds: float = 10.0,
|
|
clock: Callable[[], float] = time.monotonic,
|
|
) -> None:
|
|
self.max_age_seconds = max_age_seconds
|
|
self._clock = clock
|
|
self._entries: dict[object, _Entry] = {}
|
|
self._lock = Lock()
|
|
|
|
def get(self, key: object, revision: int) -> CachedRepresentation | None:
|
|
with self._lock:
|
|
entry = self._entries.get(key)
|
|
if entry is None:
|
|
return None
|
|
if entry.revision != revision or self._clock() >= entry.expires_at:
|
|
del self._entries[key]
|
|
return None
|
|
return entry.value
|
|
|
|
def put(
|
|
self,
|
|
key: object,
|
|
revision: int,
|
|
value: CachedRepresentation,
|
|
*,
|
|
valid_for_seconds: float | None = None,
|
|
) -> None:
|
|
ttl = self.max_age_seconds if valid_for_seconds is None else min(self.max_age_seconds, valid_for_seconds)
|
|
if ttl <= 0:
|
|
return
|
|
with self._lock:
|
|
self._entries[key] = _Entry(value=value, revision=revision, expires_at=self._clock() + ttl)
|
|
|
|
def clear(self) -> None:
|
|
with self._lock:
|
|
self._entries.clear()
|