Lukas
e2560f5db0
Add automatic cleanup of stale geolocation cache entries to prevent unbounded database growth. Resolves the issue where unique IP addresses accumulated indefinitely in the geo_cache table, degrading query performance. ## Changes ### Database Schema (Migration 3) - Add 'last_seen' column to geo_cache table tracking last reference time - Existing entries default to current timestamp ### Repository Layer (geo_cache_repo.py) - Update upsert_entry() to set/refresh last_seen on insert/update - Update upsert_neg_entry() to set/refresh last_seen on negative cache hits - Update bulk_upsert_entries() to set/refresh last_seen in batch operations - Add delete_stale_entries(db, cutoff_iso) -> int for purging old entries ### Background Task (geo_cache_cleanup.py) - New APScheduler task that runs nightly (24-hour interval) - Calculates cutoff as 90 days ago from current time (UTC) - Deletes all entries with last_seen older than cutoff - Logs operation results (info when deleted > 0, debug when 0 deleted) - Configurable retention period via GEO_CACHE_RETENTION_DAYS constant ### Application Startup (startup.py) - Register geo_cache_cleanup task in scheduler during app startup - Placed after geo_cache_flush in task registration order ### Tests - Add delete_stale_entries test cases covering: * Removal of old entries beyond cutoff * No deletion when all entries are recent * Empty table edge case - Update existing test fixtures to include last_seen column - Add full test suite for cleanup task registration and execution ### Documentation - Architekture.md: Document cleanup task, update schema/diagram - Backend-Development.md: Add retention policy documentation ## Behavior When an IP is accessed, its last_seen is refreshed. After 90 days of no access, an IP is purged by the nightly cleanup. On next encounter, the IP is re-resolved from MaxMind MMDB or ip-api.com (if configured). This is acceptable because: 1. Stale geolocation data may become inaccurate over time 2. Re-resolution cost is minimal compared to unbounded storage growth 3. Active IPs maintain fresh data through their last_seen updates Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
91 lines
3.0 KiB
Python
91 lines
3.0 KiB
Python
"""Geo cache cleanup background task.
|
|
|
|
Registers an APScheduler job that periodically removes stale entries from the
|
|
``geo_cache`` table — entries that have not been referenced in the configured
|
|
retention period (default: 90 days). This prevents unbounded growth of the
|
|
database file and maintains query performance on geo lookups.
|
|
|
|
When a stale IP is encountered again after purge, it will be re-resolved from
|
|
the MaxMind database or ip-api.com (if configured), which is acceptable.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import UTC, datetime, timedelta
|
|
from typing import TYPE_CHECKING
|
|
|
|
import structlog
|
|
|
|
from app.repositories import geo_cache_repo
|
|
from app.tasks.db import task_db
|
|
from app.utils.runtime_state import get_effective_settings
|
|
|
|
if TYPE_CHECKING:
|
|
from fastapi import FastAPI
|
|
|
|
from app.config import Settings
|
|
|
|
log: structlog.stdlib.BoundLogger = structlog.get_logger()
|
|
|
|
#: How long to retain geo cache entries (days). Configurable tuning constant.
|
|
GEO_CACHE_RETENTION_DAYS: int = 90
|
|
|
|
#: How often the cleanup job fires (seconds). Default: once per day.
|
|
GEO_CLEANUP_INTERVAL: int = 24 * 60 * 60
|
|
|
|
#: Stable APScheduler job ID — ensures re-registration replaces, not duplicates.
|
|
JOB_ID: str = "geo_cache_cleanup"
|
|
|
|
|
|
async def _run_cleanup_with_resources(settings: Settings) -> None:
|
|
"""Delete stale entries from the geo cache.
|
|
|
|
Calculates a cutoff timestamp (now - retention period) and removes all
|
|
entries with ``last_seen`` before that time. Logs the operation result.
|
|
|
|
Args:
|
|
settings: The resolved application settings used for database access.
|
|
"""
|
|
cutoff_dt = datetime.now(UTC) - timedelta(days=GEO_CACHE_RETENTION_DAYS)
|
|
cutoff_iso = cutoff_dt.strftime("%Y-%m-%dT%H:%M:%SZ")
|
|
|
|
async with task_db(settings) as db:
|
|
deleted = await geo_cache_repo.delete_stale_entries(db, cutoff_iso)
|
|
await db.commit()
|
|
|
|
if deleted > 0:
|
|
log.info("geo_cache_cleanup_ran", deleted=deleted, retention_days=GEO_CACHE_RETENTION_DAYS)
|
|
else:
|
|
log.debug("geo_cache_cleanup_ran", deleted=deleted, retention_days=GEO_CACHE_RETENTION_DAYS)
|
|
|
|
|
|
async def _run_cleanup(app: FastAPI) -> None:
|
|
"""Run cleanup with application settings."""
|
|
await _run_cleanup_with_resources(get_effective_settings(app))
|
|
|
|
|
|
def register(app: FastAPI) -> None:
|
|
"""Add (or replace) the geo cache cleanup job in the application scheduler.
|
|
|
|
Must be called after the scheduler has been started (i.e., inside the
|
|
lifespan handler, after ``scheduler.start()``).
|
|
|
|
Args:
|
|
app: The :class:`fastapi.FastAPI` application instance whose
|
|
``app.state.scheduler`` will receive the job.
|
|
"""
|
|
settings = get_effective_settings(app)
|
|
app.state.scheduler.add_job(
|
|
_run_cleanup_with_resources,
|
|
trigger="interval",
|
|
seconds=GEO_CLEANUP_INTERVAL,
|
|
kwargs={"settings": settings},
|
|
id=JOB_ID,
|
|
replace_existing=True,
|
|
)
|
|
log.info(
|
|
"geo_cache_cleanup_scheduled",
|
|
interval_seconds=GEO_CLEANUP_INTERVAL,
|
|
retention_days=GEO_CACHE_RETENTION_DAYS,
|
|
)
|