mirror of
https://github.com/zvx-echo6/central.git
synced 2026-05-21 18:14:44 +02:00
feat(3-J): enrichment framework + GeocoderEnricher + NoOpBackend + FIRMS pilot
First of three PRs for v0.5.0 (J: framework; K: real geocoder backends +
doc revisions; L: operator events tab + per-adapter render + events-map fix).
Design pivot: the Phase 2 "no enrichment, upstream verbatim" reading of
Matt's principle is reframed — consumers can't do follow-up lookups, they
only see what's on the wire, so whatever Central doesn't enrich is
effectively missing downstream. Enrichment is now expected. The producer-doc
§2/§10.1 rewrite lands in PR K; this PR builds the framework PR K documents.
New package src/central/enrichment/:
- base.py Enricher Protocol (name + async enrich(location) -> dict).
- geocoder.py GeocoderEnricher + GeocoderBackend Protocol + the locked
GEOCODER_FIELDS set (name, city, county, state, country,
postal_code, timezone, landclass, elevation_m) + all_null_bundle().
- cache.py EnrichmentCache — stdlib sqlite3 off the event loop via
asyncio.to_thread (no async-sqlite dep). Keyed on
(enricher_name, lat_4dp, lon_4dp); per-enricher TTL (24h
default); fresh connection per op (sqlite3 isn't thread-safe
to share). Cache even all-null; never cache backend failures.
- backends/no_op.py NoOpBackend — all-null bundle, the PR J default.
Provenance: enrichment results land under event.data["_enriched"][<name>];
everything else in data stays upstream verbatim.
Wiring:
- adapter.py enrichment_locations: list[tuple[str,str]] = [] class attr.
Empty (default) = publish as-is, no enrichment.
- config_models.py EnrichmentConfig (enricher_class, backend_class,
backend_settings, cache_ttl_s). Read once at startup.
- supervisor.py build_enrichers() + apply_enrichment(); enrichment runs
after dedup, before wrap_event, in the poll loop. Class-name
registries for enricher/backend resolution (PR K extends).
- firms.py enrichment_locations = [("latitude","longitude")] — pilot.
Enrichment config is read once at supervisor startup; hot-reload is out of
scope for PR J (noted in EnrichmentConfig + build_enrichers docstrings).
Tests (16 new):
- test_enrichment_framework.py (9): parent-dir/table init, cache miss->hit,
TTL expiry, 4dp rounding, nearby-coord collapse, concurrent-set single-row,
backend-failure all-null-not-cached (retries), success cached (one backend
call), all-null cached.
- test_geocoder_enricher.py (5): NoOp all-null, field-set == GEOCODER_FIELDS,
null-coords short-circuit (no backend call), name=="geocoder", sequential
same-coords single backend call.
- test_firms.py (+2): enrichment_locations declared + paths resolve to floats
in a real event (structural, not literal); event through supervisor
apply_enrichment emerges with data._enriched.geocoder == all-null bundle.
Verification: full pytest 495 passed (was 479; +16). grep for
subject_for_event/_ADAPTER_REGISTRY clean. Module imports cleanly.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
765c07aa7f
commit
d960d1f5e0
13 changed files with 685 additions and 1 deletions
|
|
@ -40,7 +40,14 @@ class SourceAdapter(ABC):
|
||||||
the wizard validates it against staged api_keys state."""
|
the wizard validates it against staged api_keys state."""
|
||||||
wizard_order: int | None = None
|
wizard_order: int | None = None
|
||||||
default_cadence_s: int
|
default_cadence_s: int
|
||||||
|
|
||||||
|
enrichment_locations: list[tuple[str, str]] = []
|
||||||
|
"""Coordinate field paths the supervisor enriches, as (lat_field, lon_field)
|
||||||
|
tuples into Event.data. Empty (the default) means publish as-is — no
|
||||||
|
enrichment. Each tuple names top-level keys in Event.data holding a
|
||||||
|
latitude and longitude; the supervisor extracts them, runs registered
|
||||||
|
enrichers, and attaches results under Event.data["_enriched"]."""
|
||||||
|
|
||||||
@abstractmethod
|
@abstractmethod
|
||||||
async def poll(self) -> AsyncIterator[Event]:
|
async def poll(self) -> AsyncIterator[Event]:
|
||||||
"""
|
"""
|
||||||
|
|
|
||||||
|
|
@ -70,6 +70,9 @@ class FIRMSAdapter(SourceAdapter):
|
||||||
wizard_order = 2
|
wizard_order = 2
|
||||||
default_cadence_s = 300
|
default_cadence_s = 300
|
||||||
|
|
||||||
|
# Enrichment pilot (PR J): FIRMS rows carry top-level latitude/longitude.
|
||||||
|
enrichment_locations = [("latitude", "longitude")]
|
||||||
|
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
config: AdapterConfig,
|
config: AdapterConfig,
|
||||||
|
|
|
||||||
|
|
@ -47,6 +47,28 @@ class AdapterConfig(BaseModel):
|
||||||
return self.paused_at is not None
|
return self.paused_at is not None
|
||||||
|
|
||||||
|
|
||||||
|
class EnrichmentConfig(BaseModel):
|
||||||
|
"""Configuration for the supervisor's enrichment stage.
|
||||||
|
|
||||||
|
Read once at supervisor startup (hot-reload is out of scope for PR J).
|
||||||
|
Defaults wire the GeocoderEnricher to the NoOpBackend (all-null bundle);
|
||||||
|
real backends arrive in PR K via backend_class + backend_settings.
|
||||||
|
"""
|
||||||
|
|
||||||
|
enricher_class: str = Field(
|
||||||
|
default="GeocoderEnricher", description="Enricher class name to instantiate"
|
||||||
|
)
|
||||||
|
backend_class: str = Field(
|
||||||
|
default="NoOpBackend", description="Backend class name to instantiate"
|
||||||
|
)
|
||||||
|
backend_settings: dict[str, Any] = Field(
|
||||||
|
default_factory=dict, description="Keyword args passed to the backend constructor"
|
||||||
|
)
|
||||||
|
cache_ttl_s: int = Field(
|
||||||
|
default=86400, description="Enrichment cache TTL in seconds (default 24h)"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class StreamConfig(BaseModel):
|
class StreamConfig(BaseModel):
|
||||||
"""Configuration for a JetStream stream."""
|
"""Configuration for a JetStream stream."""
|
||||||
|
|
||||||
|
|
|
||||||
28
src/central/enrichment/__init__.py
Normal file
28
src/central/enrichment/__init__.py
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
"""Central enrichment framework.
|
||||||
|
|
||||||
|
The supervisor runs registered enrichers over each event whose adapter
|
||||||
|
declares `enrichment_locations`, attaching results under
|
||||||
|
`event.data["_enriched"][<enricher.name>]`. Provenance is explicit: anything
|
||||||
|
under `_enriched` is Central-derived; everything else in `data` is upstream
|
||||||
|
verbatim.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from central.enrichment.backends.no_op import NoOpBackend
|
||||||
|
from central.enrichment.base import Enricher
|
||||||
|
from central.enrichment.cache import EnrichmentCache
|
||||||
|
from central.enrichment.geocoder import (
|
||||||
|
GEOCODER_FIELDS,
|
||||||
|
GeocoderBackend,
|
||||||
|
GeocoderEnricher,
|
||||||
|
all_null_bundle,
|
||||||
|
)
|
||||||
|
|
||||||
|
__all__ = [
|
||||||
|
"Enricher",
|
||||||
|
"EnrichmentCache",
|
||||||
|
"GeocoderEnricher",
|
||||||
|
"GeocoderBackend",
|
||||||
|
"GEOCODER_FIELDS",
|
||||||
|
"all_null_bundle",
|
||||||
|
"NoOpBackend",
|
||||||
|
]
|
||||||
5
src/central/enrichment/backends/__init__.py
Normal file
5
src/central/enrichment/backends/__init__.py
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
"""Geocoder backend implementations."""
|
||||||
|
|
||||||
|
from central.enrichment.backends.no_op import NoOpBackend
|
||||||
|
|
||||||
|
__all__ = ["NoOpBackend"]
|
||||||
17
src/central/enrichment/backends/no_op.py
Normal file
17
src/central/enrichment/backends/no_op.py
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
"""No-op geocoder backend — returns an all-null bundle for every input.
|
||||||
|
|
||||||
|
The default backend in PR J. Real backends (Navi, Photon, Nominatim) land in
|
||||||
|
PR K; until then the framework is exercisable end-to-end with NoOpBackend,
|
||||||
|
which satisfies the GeocoderBackend contract while resolving nothing.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from central.enrichment.geocoder import all_null_bundle
|
||||||
|
|
||||||
|
|
||||||
|
class NoOpBackend:
|
||||||
|
"""GeocoderBackend that resolves no fields."""
|
||||||
|
|
||||||
|
async def reverse(self, lat: float, lon: float) -> dict[str, Any]:
|
||||||
|
return all_null_bundle()
|
||||||
30
src/central/enrichment/base.py
Normal file
30
src/central/enrichment/base.py
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
"""Enricher protocol — the framework-level contract.
|
||||||
|
|
||||||
|
An Enricher takes a single location and returns a flat dict of enrichment
|
||||||
|
fields. The supervisor attaches each enricher's result under
|
||||||
|
`event.data["_enriched"][enricher.name]` before publishing. Everything under
|
||||||
|
`_enriched` is Central-provenance; everything else in `data` is upstream
|
||||||
|
verbatim.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from typing import Any, Protocol, runtime_checkable
|
||||||
|
|
||||||
|
|
||||||
|
@runtime_checkable
|
||||||
|
class Enricher(Protocol):
|
||||||
|
"""Pluggable enrichment unit.
|
||||||
|
|
||||||
|
name: short identifier, used as the key under event.data["_enriched"].
|
||||||
|
"""
|
||||||
|
|
||||||
|
name: str
|
||||||
|
|
||||||
|
async def enrich(self, location: dict[str, float]) -> dict[str, Any]:
|
||||||
|
"""Given a location ({"lat": float, "lon": float}), return enrichment fields.
|
||||||
|
|
||||||
|
Fields the enricher can't resolve are present with value None (NOT
|
||||||
|
omitted) so consumers see a stable field set. Implementations must
|
||||||
|
NEVER raise — they handle their own failures and return an all-null
|
||||||
|
bundle on total failure.
|
||||||
|
"""
|
||||||
|
...
|
||||||
126
src/central/enrichment/cache.py
Normal file
126
src/central/enrichment/cache.py
Normal file
|
|
@ -0,0 +1,126 @@
|
||||||
|
"""SQLite-backed enrichment cache with rounded-coords keys + TTL.
|
||||||
|
|
||||||
|
Keyed on (enricher_name, lat_rounded, lon_rounded) where coordinates are
|
||||||
|
rounded to 4 decimal places (~11 m). Uses stdlib sqlite3 off the event loop
|
||||||
|
via asyncio.to_thread (no async-sqlite dependency in the project). A fresh
|
||||||
|
connection is opened per operation — sqlite3 connections are not safe to
|
||||||
|
share across threads, and to_thread may run ops on different pool threads.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import sqlite3
|
||||||
|
from datetime import datetime, timezone
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
_COORD_PRECISION = 4
|
||||||
|
|
||||||
|
_SCHEMA = """
|
||||||
|
CREATE TABLE IF NOT EXISTS enrichment_cache (
|
||||||
|
enricher_name TEXT NOT NULL,
|
||||||
|
lat_rounded REAL NOT NULL,
|
||||||
|
lon_rounded REAL NOT NULL,
|
||||||
|
payload_json TEXT NOT NULL,
|
||||||
|
cached_at TEXT NOT NULL,
|
||||||
|
PRIMARY KEY (enricher_name, lat_rounded, lon_rounded)
|
||||||
|
)
|
||||||
|
"""
|
||||||
|
|
||||||
|
|
||||||
|
def round_coord(value: float) -> float:
|
||||||
|
"""Round a coordinate to the cache-key precision (4 dp)."""
|
||||||
|
return round(float(value), _COORD_PRECISION)
|
||||||
|
|
||||||
|
|
||||||
|
class EnrichmentCache:
|
||||||
|
"""Thread-offloaded sqlite cache for enrichment bundles."""
|
||||||
|
|
||||||
|
def __init__(self, db_path: str | Path, ttl_s: int = 86400) -> None:
|
||||||
|
self._db_path = Path(db_path)
|
||||||
|
self._ttl_s = ttl_s
|
||||||
|
self._db_path.parent.mkdir(parents=True, exist_ok=True)
|
||||||
|
self._init_db()
|
||||||
|
|
||||||
|
def _connect(self) -> sqlite3.Connection:
|
||||||
|
return sqlite3.connect(self._db_path, timeout=30)
|
||||||
|
|
||||||
|
def _init_db(self) -> None:
|
||||||
|
conn = self._connect()
|
||||||
|
try:
|
||||||
|
conn.execute(_SCHEMA)
|
||||||
|
conn.commit()
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
# --- sync bodies (run inside asyncio.to_thread) ------------------------
|
||||||
|
|
||||||
|
def _get_sync(self, enricher_name: str, lat: float, lon: float) -> dict[str, Any] | None:
|
||||||
|
lat_r = round_coord(lat)
|
||||||
|
lon_r = round_coord(lon)
|
||||||
|
conn = self._connect()
|
||||||
|
try:
|
||||||
|
cur = conn.execute(
|
||||||
|
"""
|
||||||
|
SELECT payload_json, cached_at FROM enrichment_cache
|
||||||
|
WHERE enricher_name = ? AND lat_rounded = ? AND lon_rounded = ?
|
||||||
|
""",
|
||||||
|
(enricher_name, lat_r, lon_r),
|
||||||
|
)
|
||||||
|
row = cur.fetchone()
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
if row is None:
|
||||||
|
return None
|
||||||
|
payload_json, cached_at_iso = row
|
||||||
|
if self._is_expired(cached_at_iso):
|
||||||
|
return None
|
||||||
|
return json.loads(payload_json)
|
||||||
|
|
||||||
|
def _set_sync(
|
||||||
|
self, enricher_name: str, lat: float, lon: float, payload: dict[str, Any]
|
||||||
|
) -> None:
|
||||||
|
lat_r = round_coord(lat)
|
||||||
|
lon_r = round_coord(lon)
|
||||||
|
now_iso = datetime.now(timezone.utc).isoformat()
|
||||||
|
conn = self._connect()
|
||||||
|
try:
|
||||||
|
conn.execute(
|
||||||
|
"""
|
||||||
|
INSERT INTO enrichment_cache
|
||||||
|
(enricher_name, lat_rounded, lon_rounded, payload_json, cached_at)
|
||||||
|
VALUES (?, ?, ?, ?, ?)
|
||||||
|
ON CONFLICT (enricher_name, lat_rounded, lon_rounded) DO UPDATE SET
|
||||||
|
payload_json = excluded.payload_json,
|
||||||
|
cached_at = excluded.cached_at
|
||||||
|
""",
|
||||||
|
(enricher_name, lat_r, lon_r, json.dumps(payload), now_iso),
|
||||||
|
)
|
||||||
|
conn.commit()
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
def _is_expired(self, cached_at_iso: str) -> bool:
|
||||||
|
try:
|
||||||
|
cached_at = datetime.fromisoformat(cached_at_iso)
|
||||||
|
except ValueError:
|
||||||
|
return True
|
||||||
|
if cached_at.tzinfo is None:
|
||||||
|
cached_at = cached_at.replace(tzinfo=timezone.utc)
|
||||||
|
age_s = (datetime.now(timezone.utc) - cached_at).total_seconds()
|
||||||
|
return age_s > self._ttl_s
|
||||||
|
|
||||||
|
# --- async surface -----------------------------------------------------
|
||||||
|
|
||||||
|
async def get(self, enricher_name: str, lat: float, lon: float) -> dict[str, Any] | None:
|
||||||
|
"""Return the cached bundle, or None on miss / expiry."""
|
||||||
|
return await asyncio.to_thread(self._get_sync, enricher_name, lat, lon)
|
||||||
|
|
||||||
|
async def set(
|
||||||
|
self, enricher_name: str, lat: float, lon: float, payload: dict[str, Any]
|
||||||
|
) -> None:
|
||||||
|
"""Cache a bundle (idempotent upsert on the rounded-coords key)."""
|
||||||
|
await asyncio.to_thread(self._set_sync, enricher_name, lat, lon, payload)
|
||||||
92
src/central/enrichment/geocoder.py
Normal file
92
src/central/enrichment/geocoder.py
Normal file
|
|
@ -0,0 +1,92 @@
|
||||||
|
"""Reverse-geocoding enricher + the pluggable backend contract.
|
||||||
|
|
||||||
|
GeocoderEnricher is the only enricher in PR J. It owns the cache + the
|
||||||
|
all-null normalization; the actual lookup is delegated to a GeocoderBackend.
|
||||||
|
PR J ships NoOpBackend only (all-null); real backends (Navi/Photon/Nominatim)
|
||||||
|
land in PR K.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import Any, Protocol, runtime_checkable
|
||||||
|
|
||||||
|
from central.enrichment.cache import EnrichmentCache
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
# Locked canonical geocoder field set. The single source of truth for what a
|
||||||
|
# geocoder enrichment bundle looks like — backends fill what they can and
|
||||||
|
# return None for the rest; NoOpBackend returns all None.
|
||||||
|
GEOCODER_FIELDS: tuple[str, ...] = (
|
||||||
|
"name",
|
||||||
|
"city",
|
||||||
|
"county",
|
||||||
|
"state",
|
||||||
|
"country",
|
||||||
|
"postal_code",
|
||||||
|
"timezone",
|
||||||
|
"landclass",
|
||||||
|
"elevation_m",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def all_null_bundle() -> dict[str, Any]:
|
||||||
|
"""A geocoder bundle with every locked field present and None."""
|
||||||
|
return {field: None for field in GEOCODER_FIELDS}
|
||||||
|
|
||||||
|
|
||||||
|
@runtime_checkable
|
||||||
|
class GeocoderBackend(Protocol):
|
||||||
|
"""The pluggable reverse-geocoding layer beneath GeocoderEnricher."""
|
||||||
|
|
||||||
|
async def reverse(self, lat: float, lon: float) -> dict[str, Any]:
|
||||||
|
"""Return canonical geocoder fields (see GEOCODER_FIELDS).
|
||||||
|
|
||||||
|
Fields the backend can't resolve return None. Must never raise.
|
||||||
|
"""
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
class GeocoderEnricher:
|
||||||
|
"""Reverse-geocode a location into the canonical geocoder field set.
|
||||||
|
|
||||||
|
Resolution: cache hit -> return cached; cache miss -> call backend, cache
|
||||||
|
the (normalized) result even when all-null, return it. Backend failure
|
||||||
|
(any exception escaping the backend's "never raise" contract) -> return
|
||||||
|
all-null and DO NOT cache, so the next call retries.
|
||||||
|
"""
|
||||||
|
|
||||||
|
name = "geocoder"
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
backend: GeocoderBackend,
|
||||||
|
cache: EnrichmentCache | None = None,
|
||||||
|
) -> None:
|
||||||
|
self._backend = backend
|
||||||
|
self._cache = cache
|
||||||
|
|
||||||
|
async def enrich(self, location: dict[str, float]) -> dict[str, Any]:
|
||||||
|
lat = location.get("lat")
|
||||||
|
lon = location.get("lon")
|
||||||
|
if lat is None or lon is None:
|
||||||
|
return all_null_bundle()
|
||||||
|
|
||||||
|
if self._cache is not None:
|
||||||
|
cached = await self._cache.get(self.name, lat, lon)
|
||||||
|
if cached is not None:
|
||||||
|
return cached
|
||||||
|
|
||||||
|
try:
|
||||||
|
raw = await self._backend.reverse(lat, lon)
|
||||||
|
except Exception:
|
||||||
|
# Backend broke its "never raise" contract. Return all-null and do
|
||||||
|
# NOT cache, so a transient failure doesn't get pinned for the TTL.
|
||||||
|
logger.exception("geocoder backend raised; returning all-null bundle")
|
||||||
|
return all_null_bundle()
|
||||||
|
|
||||||
|
# Normalize to the locked field set: every field present, extras dropped.
|
||||||
|
normalized = {field: raw.get(field) for field in GEOCODER_FIELDS}
|
||||||
|
|
||||||
|
if self._cache is not None:
|
||||||
|
await self._cache.set(self.name, lat, lon, normalized)
|
||||||
|
return normalized
|
||||||
|
|
@ -21,9 +21,65 @@ from central.config_source import ConfigSource, DbConfigSource
|
||||||
from central.config_store import ConfigStore
|
from central.config_store import ConfigStore
|
||||||
from central.bootstrap_config import get_settings
|
from central.bootstrap_config import get_settings
|
||||||
from central.api_key_resolver import resolve_api_key_alias
|
from central.api_key_resolver import resolve_api_key_alias
|
||||||
|
from central.config_models import EnrichmentConfig
|
||||||
|
from central.enrichment.base import Enricher
|
||||||
|
from central.enrichment.cache import EnrichmentCache
|
||||||
|
from central.enrichment.backends.no_op import NoOpBackend
|
||||||
|
from central.enrichment.geocoder import GeocoderEnricher
|
||||||
|
from central.models import Event
|
||||||
from central.stream_manager import StreamManager
|
from central.stream_manager import StreamManager
|
||||||
from central.streams import STREAMS as STREAM_REGISTRY
|
from central.streams import STREAMS as STREAM_REGISTRY
|
||||||
CURSOR_DB_PATH = Path("/var/lib/central/cursors.db")
|
CURSOR_DB_PATH = Path("/var/lib/central/cursors.db")
|
||||||
|
ENRICHMENT_CACHE_DB_PATH = Path("/var/lib/central/enrichment_cache.db")
|
||||||
|
|
||||||
|
# Enricher / backend class-name registries for EnrichmentConfig resolution.
|
||||||
|
# PR J ships GeocoderEnricher + NoOpBackend only; PR K extends these.
|
||||||
|
_ENRICHER_REGISTRY: dict[str, type] = {"GeocoderEnricher": GeocoderEnricher}
|
||||||
|
_BACKEND_REGISTRY: dict[str, type] = {"NoOpBackend": NoOpBackend}
|
||||||
|
|
||||||
|
|
||||||
|
def build_enrichers(
|
||||||
|
enrichment_config: EnrichmentConfig,
|
||||||
|
cache_db_path: Path = ENRICHMENT_CACHE_DB_PATH,
|
||||||
|
) -> list[Enricher]:
|
||||||
|
"""Instantiate the configured enricher(s) with their backend + cache.
|
||||||
|
|
||||||
|
Read once at supervisor startup — enrichment config is NOT hot-reloaded
|
||||||
|
in PR J (see EnrichmentConfig docstring).
|
||||||
|
"""
|
||||||
|
backend_cls = _BACKEND_REGISTRY[enrichment_config.backend_class]
|
||||||
|
backend = backend_cls(**enrichment_config.backend_settings)
|
||||||
|
cache = EnrichmentCache(cache_db_path, ttl_s=enrichment_config.cache_ttl_s)
|
||||||
|
enricher_cls = _ENRICHER_REGISTRY[enrichment_config.enricher_class]
|
||||||
|
return [enricher_cls(backend, cache=cache)]
|
||||||
|
|
||||||
|
|
||||||
|
async def apply_enrichment(
|
||||||
|
event: Event,
|
||||||
|
enrichment_locations: list[tuple[str, str]],
|
||||||
|
enrichers: list[Enricher],
|
||||||
|
) -> None:
|
||||||
|
"""Attach enrichment results to event.data["_enriched"] in place.
|
||||||
|
|
||||||
|
No-op when the adapter declares no enrichment_locations or no enrichers
|
||||||
|
are registered. Uses the first (lat_path, lon_path) tuple that resolves to
|
||||||
|
a non-null coordinate pair in event.data. Each enricher's result is keyed
|
||||||
|
by enricher.name. Mutates the data dict in place (Event is frozen, but its
|
||||||
|
data dict is not — this avoids a model_copy on every published event).
|
||||||
|
"""
|
||||||
|
if not enrichment_locations or not enrichers:
|
||||||
|
return
|
||||||
|
for lat_path, lon_path in enrichment_locations:
|
||||||
|
lat = event.data.get(lat_path)
|
||||||
|
lon = event.data.get(lon_path)
|
||||||
|
if lat is None or lon is None:
|
||||||
|
continue
|
||||||
|
location = {"lat": float(lat), "lon": float(lon)}
|
||||||
|
enriched: dict[str, Any] = {}
|
||||||
|
for enricher in enrichers:
|
||||||
|
enriched[enricher.name] = await enricher.enrich(location)
|
||||||
|
event.data["_enriched"] = enriched
|
||||||
|
return
|
||||||
|
|
||||||
# Stream subject mappings -- derived from the registry; every stream is included
|
# Stream subject mappings -- derived from the registry; every stream is included
|
||||||
# (META too: supervisor must create it in JetStream even though archive skips it).
|
# (META too: supervisor must create it in JetStream even though archive skips it).
|
||||||
|
|
@ -96,11 +152,16 @@ class Supervisor:
|
||||||
config_store: ConfigStore,
|
config_store: ConfigStore,
|
||||||
nats_url: str,
|
nats_url: str,
|
||||||
cloudevents_config: Any = None,
|
cloudevents_config: Any = None,
|
||||||
|
enrichment_config: EnrichmentConfig | None = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
self._config_source = config_source
|
self._config_source = config_source
|
||||||
self._config_store = config_store
|
self._config_store = config_store
|
||||||
self._nats_url = nats_url
|
self._nats_url = nats_url
|
||||||
self._cloudevents_config = cloudevents_config
|
self._cloudevents_config = cloudevents_config
|
||||||
|
# Enrichment is read once at startup (no hot-reload in PR J).
|
||||||
|
self._enrichers: list[Enricher] = build_enrichers(
|
||||||
|
enrichment_config or EnrichmentConfig()
|
||||||
|
)
|
||||||
self._adapters = discover_adapters()
|
self._adapters = discover_adapters()
|
||||||
self._nc: nats.NATS | None = None
|
self._nc: nats.NATS | None = None
|
||||||
self._js: JetStreamContext | None = None
|
self._js: JetStreamContext | None = None
|
||||||
|
|
@ -217,6 +278,16 @@ class Supervisor:
|
||||||
state.adapter.bump_last_seen(event.id)
|
state.adapter.bump_last_seen(event.id)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
# Enrichment (no-op unless the adapter declares
|
||||||
|
# enrichment_locations). Runs after dedup so we don't
|
||||||
|
# enrich events we'd skip, and before wrap_event so the
|
||||||
|
# _enriched block lands in the published payload.
|
||||||
|
await apply_enrichment(
|
||||||
|
event,
|
||||||
|
state.adapter.enrichment_locations,
|
||||||
|
self._enrichers,
|
||||||
|
)
|
||||||
|
|
||||||
# Build CloudEvent (uses defaults if no config provided)
|
# Build CloudEvent (uses defaults if no config provided)
|
||||||
envelope, msg_id = wrap_event(event, self._cloudevents_config)
|
envelope, msg_id = wrap_event(event, self._cloudevents_config)
|
||||||
|
|
||||||
|
|
@ -764,6 +835,9 @@ async def async_main() -> None:
|
||||||
nats_url=settings.nats_url,
|
nats_url=settings.nats_url,
|
||||||
# CloudEvents uses protocol-level defaults from cloudevents_constants
|
# CloudEvents uses protocol-level defaults from cloudevents_constants
|
||||||
cloudevents_config=None,
|
cloudevents_config=None,
|
||||||
|
# Enrichment defaults: GeocoderEnricher + NoOpBackend (all-null). Read
|
||||||
|
# once here at startup; PR K wires real backends + DB-backed config.
|
||||||
|
enrichment_config=EnrichmentConfig(),
|
||||||
)
|
)
|
||||||
logger.info(
|
logger.info(
|
||||||
"CloudEvents config: defaults",
|
"CloudEvents config: defaults",
|
||||||
|
|
|
||||||
160
tests/test_enrichment_framework.py
Normal file
160
tests/test_enrichment_framework.py
Normal file
|
|
@ -0,0 +1,160 @@
|
||||||
|
"""Tests for the enrichment cache + framework wiring.
|
||||||
|
|
||||||
|
Covers cache hit/miss/TTL/rounding, idempotent concurrent writes, and the
|
||||||
|
"backend failure -> all-null, not cached" contract via GeocoderEnricher.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import json
|
||||||
|
import sqlite3
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from central.enrichment.cache import EnrichmentCache, round_coord
|
||||||
|
from central.enrichment.geocoder import GEOCODER_FIELDS, GeocoderEnricher, all_null_bundle
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def cache_path(tmp_path: Path) -> Path:
|
||||||
|
return tmp_path / "nested" / "enrichment_cache.db"
|
||||||
|
|
||||||
|
|
||||||
|
def test_init_creates_parent_dir_and_table(cache_path: Path):
|
||||||
|
assert not cache_path.parent.exists()
|
||||||
|
cache = EnrichmentCache(cache_path, ttl_s=60)
|
||||||
|
assert cache_path.parent.is_dir()
|
||||||
|
# Table exists and is queryable.
|
||||||
|
conn = sqlite3.connect(cache_path)
|
||||||
|
try:
|
||||||
|
cur = conn.execute(
|
||||||
|
"SELECT name FROM sqlite_master WHERE type='table' AND name='enrichment_cache'"
|
||||||
|
)
|
||||||
|
assert cur.fetchone() is not None
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_cache_miss_then_hit(cache_path: Path):
|
||||||
|
cache = EnrichmentCache(cache_path, ttl_s=3600)
|
||||||
|
assert await cache.get("geocoder", 45.0, -116.0) is None # miss
|
||||||
|
payload = {"name": "Somewhere", "state": "ID"}
|
||||||
|
await cache.set("geocoder", 45.0, -116.0, payload)
|
||||||
|
hit = await cache.get("geocoder", 45.0, -116.0)
|
||||||
|
assert hit == payload
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_ttl_expiry_returns_miss(cache_path: Path):
|
||||||
|
cache = EnrichmentCache(cache_path, ttl_s=0) # everything immediately stale
|
||||||
|
await cache.set("geocoder", 1.0, 2.0, {"name": "x"})
|
||||||
|
# ttl_s=0 -> age (>0) always exceeds ttl -> treated as expired.
|
||||||
|
assert await cache.get("geocoder", 1.0, 2.0) is None
|
||||||
|
|
||||||
|
|
||||||
|
def test_round_coord_4dp():
|
||||||
|
assert round_coord(45.123456789) == 45.1235
|
||||||
|
assert round_coord(-116.000049) == -116.0
|
||||||
|
assert round_coord(12.99995) == 13.0
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_rounding_collapses_nearby_coords_to_same_key(cache_path: Path):
|
||||||
|
cache = EnrichmentCache(cache_path, ttl_s=3600)
|
||||||
|
await cache.set("geocoder", 45.12341, -116.45678, {"name": "rounded"})
|
||||||
|
# 45.123413 / -116.456784 round to the same 4dp key -> same row.
|
||||||
|
hit = await cache.get("geocoder", 45.123413, -116.456784)
|
||||||
|
assert hit == {"name": "rounded"}
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_concurrent_sets_do_not_double_write(cache_path: Path):
|
||||||
|
cache = EnrichmentCache(cache_path, ttl_s=3600)
|
||||||
|
await asyncio.gather(
|
||||||
|
*[cache.set("geocoder", 10.0, 20.0, {"n": i}) for i in range(20)]
|
||||||
|
)
|
||||||
|
conn = sqlite3.connect(cache_path)
|
||||||
|
try:
|
||||||
|
count = conn.execute(
|
||||||
|
"SELECT COUNT(*) FROM enrichment_cache WHERE enricher_name='geocoder' "
|
||||||
|
"AND lat_rounded=? AND lon_rounded=?",
|
||||||
|
(10.0, 20.0),
|
||||||
|
).fetchone()[0]
|
||||||
|
finally:
|
||||||
|
conn.close()
|
||||||
|
assert count == 1, "PRIMARY KEY must collapse concurrent writes to one row"
|
||||||
|
|
||||||
|
|
||||||
|
class _CountingBackend:
|
||||||
|
"""Backend that counts reverse() calls; lets tests prove cache hits."""
|
||||||
|
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.calls = 0
|
||||||
|
|
||||||
|
async def reverse(self, lat: float, lon: float) -> dict[str, Any]:
|
||||||
|
self.calls += 1
|
||||||
|
return {**all_null_bundle(), "name": "Counted", "state": "ID"}
|
||||||
|
|
||||||
|
|
||||||
|
class _ExplodingBackend:
|
||||||
|
"""Backend that violates the never-raise contract."""
|
||||||
|
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.calls = 0
|
||||||
|
|
||||||
|
async def reverse(self, lat: float, lon: float) -> dict[str, Any]:
|
||||||
|
self.calls += 1
|
||||||
|
raise RuntimeError("upstream geocoder down")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_backend_failure_returns_all_null_and_does_not_cache(cache_path: Path):
|
||||||
|
cache = EnrichmentCache(cache_path, ttl_s=3600)
|
||||||
|
backend = _ExplodingBackend()
|
||||||
|
enricher = GeocoderEnricher(backend, cache=cache)
|
||||||
|
|
||||||
|
result = await enricher.enrich({"lat": 5.0, "lon": 6.0})
|
||||||
|
assert result == all_null_bundle()
|
||||||
|
|
||||||
|
# Nothing cached -> a second call retries the backend (calls increments).
|
||||||
|
assert await cache.get("geocoder", 5.0, 6.0) is None
|
||||||
|
await enricher.enrich({"lat": 5.0, "lon": 6.0})
|
||||||
|
assert backend.calls == 2, "failed lookups must not be cached (must retry)"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_successful_result_is_cached_and_avoids_second_backend_call(cache_path: Path):
|
||||||
|
cache = EnrichmentCache(cache_path, ttl_s=3600)
|
||||||
|
backend = _CountingBackend()
|
||||||
|
enricher = GeocoderEnricher(backend, cache=cache)
|
||||||
|
|
||||||
|
first = await enricher.enrich({"lat": 7.5, "lon": 8.5})
|
||||||
|
second = await enricher.enrich({"lat": 7.5, "lon": 8.5})
|
||||||
|
assert first == second
|
||||||
|
assert backend.calls == 1, "second call with same coords must hit cache"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_all_null_result_is_cached(cache_path: Path):
|
||||||
|
"""A backend that resolves nothing still gets cached — the contract says
|
||||||
|
cache even all-null so we don't re-hammer the backend for known-empty
|
||||||
|
coordinates."""
|
||||||
|
|
||||||
|
class _NullCounting:
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.calls = 0
|
||||||
|
|
||||||
|
async def reverse(self, lat: float, lon: float) -> dict[str, Any]:
|
||||||
|
self.calls += 1
|
||||||
|
return all_null_bundle()
|
||||||
|
|
||||||
|
cache = EnrichmentCache(cache_path, ttl_s=3600)
|
||||||
|
backend = _NullCounting()
|
||||||
|
enricher = GeocoderEnricher(backend, cache=cache)
|
||||||
|
await enricher.enrich({"lat": 1.0, "lon": 1.0})
|
||||||
|
await enricher.enrich({"lat": 1.0, "lon": 1.0})
|
||||||
|
assert backend.calls == 1
|
||||||
|
cached = await cache.get("geocoder", 1.0, 1.0)
|
||||||
|
assert cached == all_null_bundle()
|
||||||
|
|
@ -421,3 +421,58 @@ class TestApplyConfig:
|
||||||
assert adapter._satellites == ["VIIRS_NOAA20_NRT"]
|
assert adapter._satellites == ["VIIRS_NOAA20_NRT"]
|
||||||
|
|
||||||
await adapter.shutdown()
|
await adapter.shutdown()
|
||||||
|
|
||||||
|
|
||||||
|
class TestEnrichmentIntegration:
|
||||||
|
"""FIRMS is the PR J enrichment pilot."""
|
||||||
|
|
||||||
|
def test_enrichment_locations_declared_and_resolvable(self, temp_db_path, mock_config_store):
|
||||||
|
"""FIRMS declares enrichment_locations and the declared paths actually
|
||||||
|
resolve to coordinates in a real event's data — verified structurally,
|
||||||
|
not by hardcoding the literal tuple."""
|
||||||
|
locations = getattr(FIRMSAdapter, "enrichment_locations")
|
||||||
|
assert isinstance(locations, list) and len(locations) >= 1
|
||||||
|
for tup in locations:
|
||||||
|
assert isinstance(tup, tuple) and len(tup) == 2
|
||||||
|
assert all(isinstance(p, str) for p in tup)
|
||||||
|
|
||||||
|
config = make_adapter_config()
|
||||||
|
adapter = FIRMSAdapter(
|
||||||
|
config=config,
|
||||||
|
config_store=mock_config_store,
|
||||||
|
cursor_db_path=temp_db_path,
|
||||||
|
)
|
||||||
|
rows = adapter._parse_csv(SAMPLE_CSV, "VIIRS_SNPP_NRT")
|
||||||
|
event = adapter._row_to_event(rows[0], "VIIRS_SNPP_NRT")
|
||||||
|
# Every declared (lat_path, lon_path) must resolve to a float in data.
|
||||||
|
for lat_path, lon_path in locations:
|
||||||
|
assert isinstance(event.data.get(lat_path), float)
|
||||||
|
assert isinstance(event.data.get(lon_path), float)
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_event_passes_through_supervisor_enrichment(
|
||||||
|
self, tmp_path, temp_db_path, mock_config_store
|
||||||
|
):
|
||||||
|
"""A FIRMS event run through the supervisor's enrichment stage emerges
|
||||||
|
with data._enriched.geocoder populated (all-null under NoOpBackend)."""
|
||||||
|
from central.config_models import EnrichmentConfig
|
||||||
|
from central.enrichment.geocoder import all_null_bundle
|
||||||
|
from central.supervisor import apply_enrichment, build_enrichers
|
||||||
|
|
||||||
|
config = make_adapter_config()
|
||||||
|
adapter = FIRMSAdapter(
|
||||||
|
config=config,
|
||||||
|
config_store=mock_config_store,
|
||||||
|
cursor_db_path=temp_db_path,
|
||||||
|
)
|
||||||
|
rows = adapter._parse_csv(SAMPLE_CSV, "VIIRS_SNPP_NRT")
|
||||||
|
event = adapter._row_to_event(rows[0], "VIIRS_SNPP_NRT")
|
||||||
|
assert "_enriched" not in event.data
|
||||||
|
|
||||||
|
enrichers = build_enrichers(
|
||||||
|
EnrichmentConfig(), cache_db_path=tmp_path / "enrichment_cache.db"
|
||||||
|
)
|
||||||
|
await apply_enrichment(event, adapter.enrichment_locations, enrichers)
|
||||||
|
|
||||||
|
assert "_enriched" in event.data
|
||||||
|
assert event.data["_enriched"]["geocoder"] == all_null_bundle()
|
||||||
|
|
|
||||||
65
tests/test_geocoder_enricher.py
Normal file
65
tests/test_geocoder_enricher.py
Normal file
|
|
@ -0,0 +1,65 @@
|
||||||
|
"""Tests for GeocoderEnricher with the default NoOpBackend."""
|
||||||
|
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from central.enrichment.backends.no_op import NoOpBackend
|
||||||
|
from central.enrichment.cache import EnrichmentCache
|
||||||
|
from central.enrichment.geocoder import (
|
||||||
|
GEOCODER_FIELDS,
|
||||||
|
GeocoderEnricher,
|
||||||
|
all_null_bundle,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_noop_backend_returns_all_null_bundle():
|
||||||
|
enricher = GeocoderEnricher(NoOpBackend())
|
||||||
|
result = await enricher.enrich({"lat": 45.0, "lon": -116.0})
|
||||||
|
assert result == all_null_bundle()
|
||||||
|
assert all(v is None for v in result.values())
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_field_set_matches_locked_protocol():
|
||||||
|
"""Every field in the locked GEOCODER_FIELDS set is present (all None for
|
||||||
|
NoOpBackend), and no extra keys leak through — bidirectional equality."""
|
||||||
|
enricher = GeocoderEnricher(NoOpBackend())
|
||||||
|
result = await enricher.enrich({"lat": 1.0, "lon": 2.0})
|
||||||
|
assert set(result.keys()) == set(GEOCODER_FIELDS)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_missing_coords_returns_all_null_without_backend_call():
|
||||||
|
class _Tripwire:
|
||||||
|
async def reverse(self, lat: float, lon: float) -> dict[str, Any]:
|
||||||
|
raise AssertionError("backend must not be called for null coords")
|
||||||
|
|
||||||
|
enricher = GeocoderEnricher(_Tripwire())
|
||||||
|
assert await enricher.enrich({"lat": None, "lon": None}) == all_null_bundle() # type: ignore[dict-item]
|
||||||
|
assert await enricher.enrich({}) == all_null_bundle()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_enricher_name_is_geocoder():
|
||||||
|
"""The name keys the result under event.data['_enriched'][name]."""
|
||||||
|
assert GeocoderEnricher(NoOpBackend()).name == "geocoder"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.asyncio
|
||||||
|
async def test_sequential_calls_same_coords_hit_cache(tmp_path):
|
||||||
|
class _CountingNoOp:
|
||||||
|
def __init__(self) -> None:
|
||||||
|
self.calls = 0
|
||||||
|
|
||||||
|
async def reverse(self, lat: float, lon: float) -> dict[str, Any]:
|
||||||
|
self.calls += 1
|
||||||
|
return all_null_bundle()
|
||||||
|
|
||||||
|
cache = EnrichmentCache(tmp_path / "c.db", ttl_s=3600)
|
||||||
|
backend = _CountingNoOp()
|
||||||
|
enricher = GeocoderEnricher(backend, cache=cache)
|
||||||
|
for _ in range(5):
|
||||||
|
await enricher.enrich({"lat": 33.5, "lon": -111.9})
|
||||||
|
assert backend.calls == 1, "repeated identical coords must collapse to one backend call"
|
||||||
Loading…
Add table
Add a link
Reference in a new issue