fix(cron): due-scan must not dispatch a one-shot past its grace window

create_job / update_job / resume_job all reject a one-shot whose run time is
more than ONESHOT_GRACE_SECONDS in the past ("will never fire"), and
_recoverable_oneshot_run_at never recovers such a schedule — but
_get_due_jobs_locked dispatched ANY one-shot whose *persisted* next_run_at was
in the past, even hours later (gateway down past the window, host asleep,
hand-edited jobs.json). A wall-clock one-shot then ran hours late, violating
the "will never fire" contract enforced everywhere else.

- Grace gate: a once-kind job whose next_run_dt is more than
  ONESHOT_GRACE_SECONDS in the past is never appended to the due list.
- If no run_claim/fire_claim exists (nothing was ever dispatched), retire the
  record with a diagnostic file so it stops being scanned and the miss is
  operator-visible.
- If a (possibly stale) claim exists, a run may still be in flight in another
  process: skip this scan but KEEP the record so its mark_job_run can land
  (avoids re-introducing mid-flight record deletion).
- Manual re-trigger still works: trigger_job sets next_run_at=now (inside
  grace) so an explicitly re-run stale one-shot fires.

Tests (tests/cron/test_oneshot_grace_due_scan.py): stale-not-due+retired,
within-grace-still-due, stale+claim-skipped-but-kept, retriggered-is-due, and
recurring-jobs-unaffected.
This commit is contained in:
spfcraze
2026-08-18 19:35:22 -04:00
committed by Teknium
parent 0b62c27bf1
commit b37a5bc0df
2 changed files with 188 additions and 0 deletions
+56
View File
@@ -2714,6 +2714,38 @@ def _write_wedged_oneshot_diagnostic(job: Dict[str, Any]) -> None:
)
def _write_missed_oneshot_diagnostic(job: Dict[str, Any], next_run: str) -> None:
"""Leave an operator-visible trace when a never-ran one-shot is retired
because its persisted run time fell outside the grace window.
The record is removed because the scheduler will never fire it (see the
grace gate in ``_get_due_jobs_locked``); without a diagnostic the job
would just vanish. Best-effort: a diagnostic failure never blocks the
removal itself.
"""
try:
text = (
"# Cron job removed before firing (run time outside grace window)\n\n"
f"- job id: {job.get('id')}\n"
f"- name: {job.get('name')}\n"
f"- scheduled run time: {next_run}\n"
f"- grace window: {ONESHOT_GRACE_SECONDS}s\n"
f"- removed at: {_hermes_now().isoformat()}\n\n"
"This one-shot's run time is more than the grace window in the "
"past (scheduler down past the window, host asleep, or jobs.json "
"edited), which is outside the 'will never fire' contract "
"enforced at create/update/resume time. The job was removed "
"without running; recreate it (or use the Run button) to "
"schedule it again.\n"
)
save_job_output(job.get("id", ""), text)
except Exception as e:
logger.debug(
"Failed to write missed-oneshot diagnostic for job %r: %s",
job.get("id"), e,
)
def claim_dispatch(job_id: str) -> bool:
"""Atomically claim a finite one-shot job dispatch BEFORE execution.
@@ -3535,6 +3567,30 @@ def _get_due_jobs_locked() -> List[Dict[str, Any]]:
record_catch_up_occurrence()
# Fall through to due.append(job) — execute once now
# One-shot grace gate: a one-shot whose persisted run time is
# beyond the grace window must never fire. create_job /
# update_job / resume_job all reject such schedules ("will
# never fire") and _recoverable_oneshot_run_at never recovers
# them — only the due-scan acted differently and dispatched a
# wall-clock one-shot hours late (gateway down past the
# window, host asleep, hand-edited jobs.json).
if kind == "once" and (now - next_run_dt).total_seconds() > ONESHOT_GRACE_SECONDS:
if not (job.get("run_claim") or job.get("fire_claim")):
# Nothing was ever dispatched — retire the record with
# a diagnostic so it stops being scanned and the miss
# is operator-visible (retire-not-silently-delete).
_write_missed_oneshot_diagnostic(job, next_run)
for rj in raw_jobs:
if rj["id"] == job["id"]:
raw_jobs.remove(rj)
intentionally_removed.add(str(job["id"]))
needs_save = True
break
# A (possibly stale) claim may mean a run is still in
# flight in another process — skip this scan but keep the
# record so its mark_job_run can still land.
continue
# One-shot dispatch-limit guard (issue #38758): a finite one-shot
# claimed via claim_dispatch() but whose tick died before
# mark_job_run could remove it will have completed >= times while
+132
View File
@@ -0,0 +1,132 @@
"""Due-scan grace gate for one-shot cron jobs.
create_job / update_job / resume_job all reject a one-shot whose run time is
more than ONESHOT_GRACE_SECONDS in the past ("will never fire"), and
``_recoverable_oneshot_run_at`` never recovers such a schedule — but the
due-scan (``_get_due_jobs_locked``) used to dispatch any one-shot whose
*persisted* ``next_run_at`` was in the past, even hours later (gateway down
past the window, host asleep, hand-edited jobs.json). That fired a
wall-clock one-shot late, contradicting the "will never fire" contract.
These tests pin the due-scan grace gate:
- beyond grace -> not due; record retired with a diagnostic
- within grace -> still due (legitimate catch-up)
- beyond grace + claim -> not due, but the record is kept (a run may be
in flight in another process; its mark_job_run must still land)
- re-triggered -> due again (the Run button still works)
"""
import pytest
from datetime import datetime, timedelta, timezone
from cron.jobs import (
get_due_jobs,
load_jobs,
save_jobs,
save_job_output,
trigger_job,
_hermes_now,
ONESHOT_GRACE_SECONDS,
)
FIXED_NOW = datetime(2026, 6, 22, 12, 0, 0, tzinfo=timezone.utc)
@pytest.fixture()
def cron_store(tmp_path, monkeypatch):
"""Redirect cron storage to a temp dir and pin the clock."""
monkeypatch.setattr("cron.jobs.CRON_DIR", tmp_path / "cron")
monkeypatch.setattr("cron.jobs.JOBS_FILE", tmp_path / "cron" / "jobs.json")
monkeypatch.setattr("cron.jobs.OUTPUT_DIR", tmp_path / "cron" / "output")
monkeypatch.setattr("cron.jobs._hermes_now", lambda: FIXED_NOW)
return tmp_path
def _oneshot(jid, run_at_dt, *, completed=0, run_claim=None, fire_claim=None):
return {
"id": jid,
"name": jid,
"prompt": "x",
"schedule": {"kind": "once", "run_at": run_at_dt.isoformat()},
"next_run_at": run_at_dt.isoformat(),
"last_run_at": None,
"enabled": True,
"state": "scheduled",
"repeat": {"times": 1, "completed": completed},
"deliver": "local",
"run_claim": run_claim,
"fire_claim": fire_claim,
}
class TestOneShotGraceDueScan:
def test_stale_beyond_grace_not_due_and_retired_with_diagnostic(self, cron_store):
stale = _oneshot("stale", FIXED_NOW - timedelta(hours=3))
save_jobs([stale])
due = get_due_jobs()
assert [d["id"] for d in due] == []
# Record is retired (removed) so it stops being scanned — with a
# diagnostic left behind so the miss is operator-visible.
assert [j["id"] for j in load_jobs()] == []
out_dir = cron_store / "cron" / "output" / "stale"
diag = list(out_dir.glob("*.md")) if out_dir.exists() else []
assert diag, "expected a diagnostic file for the retired stale one-shot"
assert "outside grace window" in diag[0].read_text(encoding="utf-8")
def test_within_grace_still_due(self, cron_store):
recent = _oneshot("recent", FIXED_NOW - timedelta(seconds=60))
save_jobs([recent])
due = get_due_jobs()
assert [d["id"] for d in due] == ["recent"]
# Still stored (dispatch proceeds normally).
assert [j["id"] for j in load_jobs()] == ["recent"]
def test_stale_with_claim_skipped_but_record_kept(self, cron_store):
# A (possibly stale) run_claim means a run may still be in flight in
# another process — the due-scan must not fire OR retire the record,
# so mark_job_run can still land.
claimed = _oneshot(
"claimed",
FIXED_NOW - timedelta(hours=3),
completed=1,
run_claim={"at": (FIXED_NOW - timedelta(hours=3)).isoformat(), "by": "other"},
)
save_jobs([claimed])
due = get_due_jobs()
assert [d["id"] for d in due] == []
# Record preserved (not retired) despite being beyond grace.
assert [j["id"] for j in load_jobs()] == ["claimed"]
def test_retriggered_stale_oneshot_is_due(self, cron_store):
# A user can still explicitly re-run a stale one-shot: trigger_job
# sets next_run_at=now, which is inside the grace window -> due.
stale = _oneshot("stale", FIXED_NOW - timedelta(hours=3))
save_jobs([stale])
trigger_job("stale")
due = get_due_jobs()
assert [d["id"] for d in due] == ["stale"]
def test_recurring_jobs_unaffected(self, cron_store):
# The grace gate is once-kind only; a stale recurring job keeps its
# existing execute-now catch-up behavior.
interval = {
"id": "int",
"name": "int",
"prompt": "x",
"schedule": {"kind": "interval", "minutes": 60},
"next_run_at": (FIXED_NOW - timedelta(hours=2)).isoformat(),
"last_run_at": None,
"enabled": True,
"state": "scheduled",
"repeat": {"times": None, "completed": 0},
"deliver": "local",
}
save_jobs([interval])
due = get_due_jobs()
# Recurring stale handling still executes once now (existing behavior).
assert [d["id"] for d in due] == ["int"]