pyr0ball
0e3abb5e63
T8: compose.cloud.yml — multi-tenant cloud stack on port 8505, CLOUD_MODE=true, per-user encrypted data at /devl/menagerie-data, joins caddy-proxy_caddy-internal network; .env.example extended with five cloud-only env vars. T10: app/telemetry.py — log_usage_event() is the ONLY entry point to usage_events table; hard kill switch (all_disabled) checked before any DB write; complete no-op in local mode; swallows all exceptions so telemetry never crashes the app; psycopg2-binary added to requirements.txt. Event calls wired into 4_Apply.py at cover_letter_generated and job_applied. 5 tests, 413/413 total passing.
90 lines
2.9 KiB
Python
90 lines
2.9 KiB
Python
# peregrine/app/telemetry.py
|
|
"""
|
|
Usage event telemetry for cloud-hosted Peregrine.
|
|
|
|
In local-first mode (CLOUD_MODE unset/false), all functions are no-ops —
|
|
no network calls, no DB writes, no imports of psycopg2.
|
|
|
|
In cloud mode, events are written to the platform Postgres DB ONLY after
|
|
confirming the user's telemetry consent.
|
|
|
|
THE HARD RULE: if telemetry_consent.all_disabled is True for a user,
|
|
nothing is written, no exceptions. This function is the ONLY path to
|
|
usage_events — no feature may write there directly.
|
|
"""
|
|
import os
|
|
import json
|
|
from typing import Any
|
|
|
|
CLOUD_MODE: bool = os.environ.get("CLOUD_MODE", "").lower() in ("1", "true", "yes")
|
|
PLATFORM_DB_URL: str = os.environ.get("PLATFORM_DB_URL", "")
|
|
|
|
_platform_conn = None
|
|
|
|
|
|
def get_platform_conn():
|
|
"""Lazy psycopg2 connection to the platform Postgres DB. Reconnects if closed."""
|
|
global _platform_conn
|
|
if _platform_conn is None or _platform_conn.closed:
|
|
import psycopg2
|
|
_platform_conn = psycopg2.connect(PLATFORM_DB_URL)
|
|
return _platform_conn
|
|
|
|
|
|
def get_consent(user_id: str) -> dict:
|
|
"""
|
|
Fetch telemetry consent for the user.
|
|
Returns safe defaults if record doesn't exist yet:
|
|
- usage_events_enabled: True (new cloud users start opted-in, per onboarding disclosure)
|
|
- all_disabled: False
|
|
"""
|
|
conn = get_platform_conn()
|
|
with conn.cursor() as cur:
|
|
cur.execute(
|
|
"SELECT all_disabled, usage_events_enabled "
|
|
"FROM telemetry_consent WHERE user_id = %s",
|
|
(user_id,)
|
|
)
|
|
row = cur.fetchone()
|
|
if row is None:
|
|
return {"all_disabled": False, "usage_events_enabled": True}
|
|
return {"all_disabled": row[0], "usage_events_enabled": row[1]}
|
|
|
|
|
|
def log_usage_event(
|
|
user_id: str,
|
|
app: str,
|
|
event_type: str,
|
|
metadata: dict[str, Any] | None = None,
|
|
) -> None:
|
|
"""
|
|
Write a usage event to the platform DB if consent allows.
|
|
|
|
Silent no-op in local mode. Silent no-op if telemetry is disabled.
|
|
Swallows all exceptions — telemetry must never crash the app.
|
|
|
|
Args:
|
|
user_id: Directus user UUID (from st.session_state["user_id"])
|
|
app: App slug ('peregrine', 'falcon', etc.)
|
|
event_type: Snake_case event label ('cover_letter_generated', 'job_applied', etc.)
|
|
metadata: Optional JSON-serialisable dict — NO PII
|
|
"""
|
|
if not CLOUD_MODE:
|
|
return
|
|
|
|
try:
|
|
consent = get_consent(user_id)
|
|
if consent.get("all_disabled") or not consent.get("usage_events_enabled", True):
|
|
return
|
|
|
|
conn = get_platform_conn()
|
|
with conn.cursor() as cur:
|
|
cur.execute(
|
|
"INSERT INTO usage_events (user_id, app, event_type, metadata) "
|
|
"VALUES (%s, %s, %s, %s)",
|
|
(user_id, app, event_type, json.dumps(metadata) if metadata else None),
|
|
)
|
|
conn.commit()
|
|
except Exception:
|
|
# Telemetry must never crash the app
|
|
pass
|