refactor(services): one periodic-task shape, one APScheduler job shape, one token hash, one summary rule — the services pass of the shape audit (#2830, milestone 296)
CI & Build / Python lint (push) Successful in 3s
CI & Build / Plugin hooks (push) Successful in 7s
CI & Build / TypeScript typecheck (push) Successful in 12s
CI & Build / integration (push) Successful in 24s
CI & Build / Python tests (push) Successful in 55s
CI & Build / Build & push image (push) Successful in 24s
CI & Build / Python lint (push) Successful in 3s
CI & Build / Plugin hooks (push) Successful in 7s
CI & Build / TypeScript typecheck (push) Successful in 12s
CI & Build / integration (push) Successful in 24s
CI & Build / Python tests (push) Successful in 55s
CI & Build / Build & push image (push) Successful in 24s
- background.start_periodic(interval, work, label=) replaces the three hand-rolled while-True/sleep/try loops in logging, auth and notifications. - services/scheduler.ScheduledJob replaces the four private BackgroundScheduler copies in recurrence/version_pinning/trash/db_maintenance schedulers; public start_/stop_/reschedule_ surfaces unchanged. - api_keys.hash_token is the one sha256 helper; auth.py used to inline it 5x. - auth.is_registration_open reads via settings.get_admin_setting; notification prefs read via settings.get_setting; _fire_share_email uses _get_user_email. - projects.get_project_summary / milestones.get_project_milestone_summary are now the one-id view of their batch siblings instead of a second copy of the queries; sharing.best_permission_by (was _deduplicate_by_permission) is the one rank-dedup, now also used by list_projects_for_user. - backup: the row builders for every section both exporters carry are named functions, so a column added to one export cannot silently miss the other. - iso() from models.base replaces the attr.isoformat()-if-attr-else-None idiom and db_maintenance._iso across services; backup keeps its explicit shape. - trash.py hoists the sql_delete/timedelta imports it re-imported per function. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
@@ -1,9 +1,8 @@
|
||||
"""Daily APScheduler cron for basic DB maintenance (targeted VACUUM ANALYZE).
|
||||
|
||||
Mirrors trash_scheduler.py: a single global BackgroundScheduler job bridges
|
||||
into the asyncio loop to run the async maintenance. Scheduled for 04:00 UTC by
|
||||
default — after the 03:30 trash purge — so it collects the dead tuples that
|
||||
night's delete sweeps leave behind.
|
||||
One ScheduledJob (services/scheduler.py). Scheduled for 04:00 UTC by default
|
||||
— after the 03:30 trash purge — so it collects the dead tuples that night's
|
||||
delete sweeps leave behind.
|
||||
|
||||
Two things are operator-tunable from the admin Settings card:
|
||||
- db_maintenance_enabled ("true"/"false") — checked at fire time, so toggling
|
||||
@@ -16,9 +15,9 @@ from __future__ import annotations
|
||||
import asyncio
|
||||
import logging
|
||||
|
||||
from apscheduler.schedulers.background import BackgroundScheduler
|
||||
from apscheduler.triggers.cron import CronTrigger
|
||||
|
||||
from scribe.services.scheduler import ScheduledJob
|
||||
from scribe.services.settings import get_admin_setting
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
@@ -26,9 +25,6 @@ logger = logging.getLogger(__name__)
|
||||
_JOB_ID = "db_maintenance_vacuum"
|
||||
_DEFAULT_HOUR = 4
|
||||
|
||||
_scheduler: BackgroundScheduler | None = None
|
||||
_loop: asyncio.AbstractEventLoop | None = None
|
||||
|
||||
|
||||
async def get_maintenance_hour() -> int:
|
||||
"""The configured run-hour (UTC, 0–23), clamped; default 04:00."""
|
||||
@@ -45,23 +41,20 @@ async def is_maintenance_enabled() -> bool:
|
||||
return (await get_admin_setting("db_maintenance_enabled", "true")) != "false"
|
||||
|
||||
|
||||
def _run_maintenance_threadsafe() -> None:
|
||||
"""APScheduler invokes this from a worker thread; bridge into the loop."""
|
||||
if _loop is None:
|
||||
logger.warning("db maintenance scheduler: no loop registered")
|
||||
async def _run_maintenance() -> None:
|
||||
if not await is_maintenance_enabled():
|
||||
logger.debug("db maintenance: disabled, skipping scheduled run")
|
||||
return
|
||||
from scribe.services.db_maintenance import run_maintenance
|
||||
await run_maintenance()
|
||||
|
||||
async def _runner():
|
||||
try:
|
||||
if not await is_maintenance_enabled():
|
||||
logger.debug("db maintenance: disabled, skipping scheduled run")
|
||||
return
|
||||
from scribe.services.db_maintenance import run_maintenance
|
||||
await run_maintenance()
|
||||
except Exception:
|
||||
logger.exception("db maintenance run failed")
|
||||
|
||||
asyncio.run_coroutine_threadsafe(_runner(), _loop)
|
||||
_JOB = ScheduledJob(_JOB_ID, _run_maintenance, label="DB maintenance")
|
||||
|
||||
|
||||
def _trigger(hour: int) -> CronTrigger:
|
||||
hour = hour if 0 <= hour <= 23 else _DEFAULT_HOUR
|
||||
return CronTrigger(hour=hour, minute=0, timezone="UTC")
|
||||
|
||||
|
||||
def start_db_maintenance_scheduler(
|
||||
@@ -72,36 +65,15 @@ def start_db_maintenance_scheduler(
|
||||
in rather than read here so we never block the event loop at startup. The
|
||||
job's enabled-gate is re-checked at every fire, so only the hour is needed
|
||||
up front."""
|
||||
global _scheduler, _loop
|
||||
if _scheduler is not None:
|
||||
return
|
||||
_loop = loop
|
||||
hour = hour if 0 <= hour <= 23 else _DEFAULT_HOUR
|
||||
_scheduler = BackgroundScheduler()
|
||||
_scheduler.add_job(
|
||||
_run_maintenance_threadsafe,
|
||||
trigger=CronTrigger(hour=hour, minute=0, timezone="UTC"),
|
||||
id=_JOB_ID,
|
||||
replace_existing=True,
|
||||
)
|
||||
_scheduler.start()
|
||||
logger.info("DB maintenance scheduler started (daily %02d:00 UTC)", hour)
|
||||
_JOB.start(loop, _trigger(hour), describe=f"daily {hour:02d}:00 UTC")
|
||||
|
||||
|
||||
def reschedule_db_maintenance(hour: int) -> None:
|
||||
"""Move the live job to a new UTC hour (called when the admin changes it)."""
|
||||
if _scheduler is None:
|
||||
return
|
||||
hour = hour if 0 <= hour <= 23 else _DEFAULT_HOUR
|
||||
_scheduler.reschedule_job(
|
||||
_JOB_ID, trigger=CronTrigger(hour=hour, minute=0, timezone="UTC")
|
||||
)
|
||||
logger.info("DB maintenance scheduler rescheduled to %02d:00 UTC", hour)
|
||||
_JOB.reschedule(_trigger(hour), describe=f"{hour:02d}:00 UTC")
|
||||
|
||||
|
||||
def stop_db_maintenance_scheduler() -> None:
|
||||
global _scheduler
|
||||
if _scheduler is not None:
|
||||
_scheduler.shutdown(wait=False)
|
||||
_scheduler = None
|
||||
logger.info("DB maintenance scheduler stopped")
|
||||
_JOB.stop()
|
||||
|
||||
Reference in New Issue
Block a user