Files
hermes-agent/cron/bot_chat_delivery.py
teknium1 e16fc212ec fix(cron,tools): exact-id receipt reads fail closed on a non-dict JSON payload
Follow-up to the previous commit: rather than an isinstance check in every
caller (defer, deliver_to_live_owner, complete_delivery, the scheduler's
receipt comparison, bot_mode_dm's admit/wait), the two exact-id readers —
cron/bot_chat_delivery.py::read_pending and tools/bot_live_delivery.py::_read
— now raise ValueError for a payload that parses but is not a JSON object,
the same way they already propagate a PermissionError: a possibly-live
receipt is never overwritten, and the bulk-scan wrapper _scan_read turns the
same ValueError into its existing warn-once-and-skip path, so one malformed
ticket no longer wedges _next_sequence or claim_pending_delivery (#109820's
rule for the live-delivery dir).

Co-authored-by: beardthelion <beardthelion@users.noreply.github.com>
2026-09-18 09:19:04 -07:00

173 lines
7.3 KiB
Python

"""Defer never-started cron outputs behind unsupported Bot Chat owners.
Inspired by 686f6c61's queue proposal (#100319). Unlike retrying failed CLI
turns, only pending requests are eligible: a persisted claim never expires.
"""
from __future__ import annotations
import contextvars
import json
import logging
import threading
from pathlib import Path
from hermes_cli.active_sessions import _FileLock
from hermes_constants import get_hermes_home
from utils import atomic_json_write
logger = logging.getLogger(__name__)
_warned_unreadable: set[Path] = set()
_running: set[Path] = set()
_running_lock = threading.Lock()
def _root() -> Path:
return get_hermes_home().resolve() / "cron" / "bot_chat_pending"
def read_pending(key: str) -> dict | None:
"""Exact-id read: fails closed on anything but a JSON object, never licensing an overwrite."""
try:
record = json.loads((_root() / f"{key}.json").read_text(encoding="utf-8"))
except FileNotFoundError:
return None
if not isinstance(record, dict):
raise ValueError(f"deferred Bot Chat receipt {key} is not a JSON object ({type(record).__name__})")
return record
def _records(root: Path) -> list[tuple[Path, dict]]:
records = []
for path in root.glob("*.json"):
try:
record = json.loads(path.read_text(encoding="utf-8"))
if not isinstance(record, dict):
raise ValueError(f"expected a JSON object, got {type(record).__name__}")
except (OSError, ValueError) as exc: # ValueError: corrupt JSON and invalid UTF-8 alike
# Keep damaged or unreadable receipts as evidence; never replay them or block peers
# (same rule as tools/bot_live_delivery.py::_scan_read — one bad file must not wedge the dir).
# The scheduler drains every tick: ERROR once per receipt per process, DEBUG after.
level = logging.DEBUG if path in _warned_unreadable else logging.ERROR
_warned_unreadable.add(path)
logger.log(level, "Unreadable deferred Bot Chat receipt %s: %s", path, exc)
continue
_warned_unreadable.discard(path)
records.append((path, record))
return records
def defer(key: str, job: dict, content: str, profile: str, home: Path, *,
for_failure: bool = False, suppressed: bool = False) -> dict:
root = _root()
root.mkdir(parents=True, exist_ok=True, mode=0o700)
with _FileLock(root / ".lock"):
record = read_pending(key)
if record is not None:
if (record["content"] != content or record["home"] != str(home)
or bool(record.get("for_failure")) != for_failure):
raise ValueError("delivery id already belongs to a different payload")
if suppressed and record["status"] == "queued":
record.update(status="suppressed", error=None)
atomic_json_write(root / f"{key}.json", record, fsync_dir=True, mode=0o600)
return record
sequence = max((record["sequence"] for _, record in _records(root)), default=0) + 1
record = dict(id=key, status="suppressed" if suppressed else "queued", job=job, content=content,
profile=profile, home=str(home), sequence=sequence)
if for_failure:
record["for_failure"] = True
atomic_json_write(root / f"{key}.json", record, fsync_dir=True, mode=0o600)
return record
def drain(root: Path | None = None) -> None:
"""Serialize drains across processes without holding the producer lock."""
from hermes_cli.backend_retirement import retirement
root = root if root is not None else _root()
with retirement.work() as admitted:
if admitted and root.is_dir():
with _FileLock(root / ".drain.lock"):
_drain(root)
def _drain(root: Path) -> None:
"""Claim before execution. Errors/interruptions never authorize another turn."""
from cron.scheduler_delivery import _deliver_to_bot_chat
from tools.bot_live_delivery import find_canonical_live_owner, find_canonical_owner
with _FileLock(root / ".lock"):
records = sorted(_records(root), key=lambda item: item[1]["sequence"])
for path, _ in records:
with _FileLock(root / ".lock"):
record = json.loads(path.read_text(encoding="utf-8"))
if not isinstance(record, dict) or record["status"] != "queued":
continue
home = Path(record["home"])
# A failure notice queued before the target profile opted out is settled as
# suppressed at drain time; the policy is the owner's, read from its own config.
from cron.scheduler_delivery import BOT_CHAT_POLICY_PLATFORM
from gateway.warning_notifications import warning_notifications_enabled
from hermes_cli.config_effective import load_user_config_effective
if (record.get("for_failure")
and not warning_notifications_enabled(BOT_CHAT_POLICY_PLATFORM, load_user_config_effective(home / "config.yaml"))):
record.update(status="suppressed", error=None)
atomic_json_write(path, record, fsync_dir=True, mode=0o600)
continue
try:
owner = find_canonical_owner(home)
if owner is not None and find_canonical_live_owner(home) is None:
continue
except Exception:
# Discovery uncertainty is not permission to launch.
continue
record["status"] = "claimed"
atomic_json_write(path, record, fsync_dir=True, mode=0o600)
job = record["job"]
job.pop("_bot_chat_delivery_receipts", None)
try:
error = _deliver_to_bot_chat(job, record["content"], record["profile"], deferred=record)
except Exception as exc:
# The claim survives uncertainty; one failed attempt must not stop peers.
error = f"{type(exc).__name__}: {exc}"
logger.exception("Deferred Bot Chat delivery %s failed", record["id"])
receipt = job.get("_bot_chat_delivery_receipts", {}).get(
f"bot-chat:{record['profile'] or '(own)'}")
status = "transferred" if receipt else "ambiguous" if error else "settled"
if job.get("_notification_all_targets_suppressed"):
status = "suppressed"
record.update(status=status, error=error)
# A transferred live-owner receipt remains authoritative, including queued.
atomic_json_write(path, record, fsync_dir=True, mode=0o600)
def drain_in_background() -> None:
"""Do not hold up unrelated cron ticks while the eventual Bot Chat turn runs."""
home = get_hermes_home().resolve()
root = home / "cron" / "bot_chat_pending"
if not root.is_dir():
return
from hermes_cli.backend_retirement import retirement
with _running_lock:
if home in _running or not retirement.acquire():
return
_running.add(home)
def release():
with _running_lock:
_running.discard(home)
retirement.release()
def run():
try:
drain(root)
finally:
release()
try:
threading.Thread(target=contextvars.copy_context().run, args=(run,), daemon=True,
name="cron-bot-chat-drain").start()
except BaseException:
release()
raise