scheduler.py 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148
  1. """APScheduler 装配。
  2. 用 ``AsyncIOScheduler`` 与主事件循环共用同一个 loop——非 async 的调度器
  3. 会在自己的线程里跑任务,那样 ``agent.astream`` / aiosqlite 的 loop 绑定
  4. 全部失效。这是 1.5 明确记录过的约束。
  5. 启动时把 DB 里 enabled 的任务全量装载进调度器:DB 是任务定义的**事实源**,
  6. 调度器内存里的 job 只是它的一份投影。所以改任务必须「先写 DB,再同步
  7. job」,反之会在重启后丢失。
  8. """
  9. from __future__ import annotations
  10. import asyncio
  11. from typing import Any
  12. from apscheduler.schedulers.asyncio import AsyncIOScheduler
  13. from apscheduler.triggers.cron import CronTrigger
  14. from db import schedule_store
  15. from obs import get_logger
  16. from scheduler.runner import run_schedule
  17. logger = get_logger(__name__)
  18. _scheduler: AsyncIOScheduler | None = None
  19. def _job_id(schedule_id: str) -> str:
  20. return f"schedule:{schedule_id}"
  21. def _parse_cron(expr: str) -> CronTrigger:
  22. """解析 5 段 cron。非法表达式抛 ValueError,由调用方转成 400。"""
  23. return CronTrigger.from_crontab((expr or "").strip())
  24. async def _invoke(schedule_id: str) -> None:
  25. """job 回调。吞掉异常——见 scheduler/runner.run_schedule 的说明。"""
  26. try:
  27. await run_schedule(schedule_id, trigger="cron")
  28. except Exception: # pragma: no cover - run_schedule 内部已兜底
  29. logger.exception("定时任务回调异常 id=%s", schedule_id)
  30. def get_scheduler() -> AsyncIOScheduler | None:
  31. """取调度器实例;未启动返回 None。"""
  32. return _scheduler
  33. def is_running() -> bool:
  34. return _scheduler is not None and _scheduler.running
  35. async def start() -> int:
  36. """启动调度器并装载已启用的任务。返回装载条数。"""
  37. global _scheduler
  38. if _scheduler is not None and _scheduler.running:
  39. return len(_scheduler.get_jobs())
  40. _scheduler = AsyncIOScheduler(timezone="Asia/Shanghai")
  41. _scheduler.start()
  42. schedules = await asyncio.to_thread(schedule_store.list_schedules, None, True, 500)
  43. loaded = 0
  44. for schedule in schedules:
  45. try:
  46. add_job(schedule)
  47. loaded += 1
  48. except Exception as exc:
  49. # 单条 cron 非法不该让整个调度器起不来,但必须留下痕迹
  50. logger.error(
  51. "装载定时任务失败 id=%s cron=%r:%s: %s",
  52. schedule.get("id"), schedule.get("cron"), type(exc).__name__, exc,
  53. )
  54. logger.info("调度器已启动,装载 %d 个任务(扫描到 %d 条)", loaded, len(schedules))
  55. return loaded
  56. async def shutdown() -> None:
  57. """停止调度器。"""
  58. global _scheduler
  59. if _scheduler is None:
  60. return
  61. try:
  62. _scheduler.shutdown(wait=False)
  63. except Exception as exc: # pragma: no cover
  64. logger.warning("关闭调度器异常:%s: %s", type(exc).__name__, exc)
  65. _scheduler = None
  66. logger.info("调度器已停止")
  67. def add_job(schedule: dict[str, Any]) -> str:
  68. """把一个任务定义投影成调度器 job。"""
  69. if _scheduler is None:
  70. raise RuntimeError("调度器未启动")
  71. schedule_id = schedule["id"]
  72. trigger = _parse_cron(schedule["cron"])
  73. _scheduler.add_job(
  74. _invoke,
  75. trigger=trigger,
  76. args=[schedule_id],
  77. id=_job_id(schedule_id),
  78. name=schedule.get("title") or schedule_id,
  79. replace_existing=True,
  80. max_instances=1,
  81. # 错过触发时间(服务重启/长时间 GC)时不要补跑:定时任务多是
  82. # 「每日汇报」这类语义,补跑历史时点没有意义,还会突然烧一批额度
  83. misfire_grace_time=60,
  84. coalesce=True,
  85. )
  86. logger.info("已装载定时任务 id=%s cron=%s", schedule_id, schedule["cron"])
  87. return _job_id(schedule_id)
  88. def remove_job(schedule_id: str) -> bool:
  89. """摘掉 job。任务定义被删或停用时调用。"""
  90. if _scheduler is None:
  91. return False
  92. job = _scheduler.get_job(_job_id(schedule_id))
  93. if job is None:
  94. return False
  95. _scheduler.remove_job(_job_id(schedule_id))
  96. logger.info("已摘除定时任务 id=%s", schedule_id)
  97. return True
  98. def sync_job(schedule: dict[str, Any]) -> None:
  99. """按任务定义的当前状态同步 job:enabled 则装载,否则摘除。"""
  100. if schedule.get("enabled"):
  101. add_job(schedule)
  102. else:
  103. remove_job(schedule["id"])
  104. def jobs() -> list[dict[str, Any]]:
  105. """当前调度器里的 job 快照,供 /health 展示。"""
  106. if _scheduler is None:
  107. return []
  108. return [
  109. {
  110. "id": job.id,
  111. "name": job.name,
  112. "next_run_time": job.next_run_time.isoformat() if job.next_run_time else None,
  113. "trigger": str(job.trigger),
  114. }
  115. for job in _scheduler.get_jobs()
  116. ]