feat(kanban): typed block reasons + unblock-loop breaker (#52848)
* feat(kanban): typed block reasons + unblock-loop breaker Stops the kanban blocked-task loop: a worker blocks a task, a cron unblocks it, the worker re-blocks for the same reason, repeat forever. block_task now takes a typed kind and a persistent block_recurrences counter on the tasks table: - kind=dependency routes to todo (parent-gated, auto-resumed), never the human 'blocked' bucket a cron would keep unblocking. - needs_input/capability/transient/untyped land in blocked; each same-cause re-block after an unblock increments block_recurrences, and at BLOCK_RECURRENCE_LIMIT (default 2) the task routes to triage for a human instead of blocked. - unblock_task no longer resets block_recurrences (the amnesia that let the loop run unbounded); complete_task clears it on success. Wired through the worker kanban_block tool (new kind arg) and the hermes kanban block --kind CLI flag, both reporting where the task actually landed. Docs + 11 new tests; 536 existing kanban tests green. * test(kanban): make second-block notify test use a distinct block cause test_notifier_second_blocked_delivers blocked the same task twice with the same (untyped) reason, which now trips the new unblock-loop breaker and routes the second block to triage instead of blocked — so only one 'blocked' notification fired. The test's actual intent is that TWO distinct block cycles each notify; give the two cycles different kinds (needs_input then capability) so they're genuinely separate blocks. The same-cause loop→triage path is covered by test_kanban_block_kinds.py.
This commit is contained in:
parent
43b8ba4181
commit
5b5c79a8ef
6 changed files with 563 additions and 61 deletions
202
tests/hermes_cli/test_kanban_block_kinds.py
Normal file
202
tests/hermes_cli/test_kanban_block_kinds.py
Normal file
|
|
@ -0,0 +1,202 @@
|
|||
"""Tests for typed block reasons + the unblock-loop breaker.
|
||||
|
||||
Covers the built-in fix for the kanban "blocked loop" — a worker blocks a
|
||||
task, a cron unblocks it, the worker re-blocks for the same reason, repeat
|
||||
forever. The fix gives ``block_task`` a typed ``kind`` and a persistent
|
||||
``block_recurrences`` counter:
|
||||
|
||||
* ``dependency`` blocks route to ``todo`` (parent-gated, auto-resumed) and
|
||||
never enter the human ``blocked`` bucket a cron would keep unblocking.
|
||||
* ``needs_input`` / ``capability`` / un-typed blocks land in ``blocked``;
|
||||
each same-cause re-block after an unblock increments ``block_recurrences``,
|
||||
and at ``BLOCK_RECURRENCE_LIMIT`` the task routes to ``triage`` for a human.
|
||||
* ``unblock_task`` deliberately does NOT reset ``block_recurrences`` (the
|
||||
amnesia that let the loop run unbounded).
|
||||
* A successful ``complete_task`` resets the loop memory.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from hermes_cli import kanban_db as kb
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def kanban_home(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
|
||||
home = tmp_path / ".hermes"
|
||||
home.mkdir()
|
||||
monkeypatch.setenv("HERMES_HOME", str(home))
|
||||
monkeypatch.setattr(Path, "home", lambda: tmp_path)
|
||||
kb.init_db()
|
||||
return home
|
||||
|
||||
|
||||
def _running_task(conn, title="t"):
|
||||
"""Create a task and drive it to ``running`` so block_task can act."""
|
||||
tid = kb.create_task(conn, title=title, assignee="worker")
|
||||
with kb.write_txn(conn):
|
||||
conn.execute("UPDATE tasks SET status='ready' WHERE id=?", (tid,))
|
||||
claimed = kb.claim_task(conn, tid, claimer="worker")
|
||||
assert claimed is not None
|
||||
return tid
|
||||
|
||||
|
||||
def _make_running_again(conn, tid):
|
||||
with kb.write_txn(conn):
|
||||
conn.execute("UPDATE tasks SET status='ready' WHERE id=?", (tid,))
|
||||
assert kb.claim_task(conn, tid, claimer="worker") is not None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Loop breaker
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def test_first_typed_block_lands_in_blocked(kanban_home: Path) -> None:
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
assert kb.block_task(conn, tid, reason="which key?", kind="needs_input")
|
||||
t = kb.get_task(conn, tid)
|
||||
assert t.status == "blocked"
|
||||
assert t.block_kind == "needs_input"
|
||||
assert t.block_recurrences == 1
|
||||
|
||||
|
||||
def test_unblock_does_not_reset_recurrence_counter(kanban_home: Path) -> None:
|
||||
"""The crux of the fix: unblock must preserve the loop counter."""
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
kb.block_task(conn, tid, reason="x", kind="needs_input")
|
||||
assert kb.get_task(conn, tid).block_recurrences == 1
|
||||
assert kb.unblock_task(conn, tid)
|
||||
t = kb.get_task(conn, tid)
|
||||
assert t.status == "ready"
|
||||
assert t.block_recurrences == 1 # NOT reset to 0
|
||||
assert t.block_kind == "needs_input" # kind preserved for comparison
|
||||
|
||||
|
||||
def test_same_cause_reblock_routes_to_triage(kanban_home: Path) -> None:
|
||||
"""Dale's loop: block → unblock → re-block same kind → triage."""
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
kb.block_task(conn, tid, reason="need creds", kind="needs_input")
|
||||
kb.unblock_task(conn, tid)
|
||||
_make_running_again(conn, tid)
|
||||
kb.block_task(conn, tid, reason="still need creds", kind="needs_input")
|
||||
t = kb.get_task(conn, tid)
|
||||
assert t.status == "triage"
|
||||
assert t.block_recurrences == 2
|
||||
|
||||
|
||||
def test_untyped_block_loop_also_protected(kanban_home: Path) -> None:
|
||||
"""Legacy un-typed blocks (kind=None) still trip the breaker."""
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
kb.block_task(conn, tid, reason="a")
|
||||
kb.unblock_task(conn, tid)
|
||||
_make_running_again(conn, tid)
|
||||
kb.block_task(conn, tid, reason="a again")
|
||||
assert kb.get_task(conn, tid).status == "triage"
|
||||
|
||||
|
||||
def test_different_kinds_do_not_compound(kanban_home: Path) -> None:
|
||||
"""A re-block for a DIFFERENT reason resets the counter to 1."""
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
kb.block_task(conn, tid, reason="a", kind="needs_input")
|
||||
kb.unblock_task(conn, tid)
|
||||
_make_running_again(conn, tid)
|
||||
kb.block_task(conn, tid, reason="b", kind="capability")
|
||||
t = kb.get_task(conn, tid)
|
||||
assert t.status == "blocked"
|
||||
assert t.block_recurrences == 1
|
||||
|
||||
|
||||
def test_block_loop_detected_event_emitted(kanban_home: Path) -> None:
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
kb.block_task(conn, tid, reason="x", kind="capability")
|
||||
kb.unblock_task(conn, tid)
|
||||
_make_running_again(conn, tid)
|
||||
kb.block_task(conn, tid, reason="x", kind="capability")
|
||||
events = [e for e in kb.list_events(conn, tid)
|
||||
if e.kind == "block_loop_detected"]
|
||||
assert events, "expected a block_loop_detected event"
|
||||
payload = events[-1].payload or {}
|
||||
assert payload.get("recurrences") == 2
|
||||
assert payload.get("kind") == "capability"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Dependency routing
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def test_dependency_block_routes_to_todo(kanban_home: Path) -> None:
|
||||
"""Dependency waits never enter the human 'blocked' bucket."""
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
assert kb.block_task(conn, tid, reason="need X first", kind="dependency")
|
||||
t = kb.get_task(conn, tid)
|
||||
assert t.status == "todo"
|
||||
assert t.block_kind == "dependency"
|
||||
|
||||
|
||||
def test_dependency_then_parent_done_promotes(kanban_home: Path) -> None:
|
||||
"""A dependency-parked child becomes ready once its parent completes."""
|
||||
with kb.connect_closing() as conn:
|
||||
parent = kb.create_task(conn, title="parent", assignee="worker")
|
||||
child = _running_task(conn, title="child")
|
||||
kb.link_tasks(conn, parent_id=parent, child_id=child)
|
||||
kb.block_task(conn, child, reason="wait", kind="dependency")
|
||||
assert kb.get_task(conn, child).status == "todo"
|
||||
# Finish the parent, then let recompute_ready run.
|
||||
with kb.write_txn(conn):
|
||||
conn.execute("UPDATE tasks SET status='ready' WHERE id=?", (parent,))
|
||||
kb.claim_task(conn, parent, claimer="worker")
|
||||
kb.complete_task(conn, parent, result="done")
|
||||
kb.recompute_ready(conn)
|
||||
assert kb.get_task(conn, child).status == "ready"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Completion resets loop memory
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def test_completion_clears_block_memory(kanban_home: Path) -> None:
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
kb.block_task(conn, tid, reason="x", kind="capability")
|
||||
kb.unblock_task(conn, tid)
|
||||
assert kb.get_task(conn, tid).block_recurrences == 1
|
||||
kb.complete_task(conn, tid, result="done")
|
||||
t = kb.get_task(conn, tid)
|
||||
assert t.status == "done"
|
||||
assert t.block_recurrences == 0
|
||||
assert t.block_kind is None
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Validation + back-compat
|
||||
# ---------------------------------------------------------------------------
|
||||
|
||||
|
||||
def test_invalid_kind_rejected(kanban_home: Path) -> None:
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
with pytest.raises(ValueError):
|
||||
kb.block_task(conn, tid, reason="x", kind="bogus")
|
||||
|
||||
|
||||
def test_block_without_kind_is_backward_compatible(kanban_home: Path) -> None:
|
||||
"""Existing callers that pass no kind keep the old single-block behaviour."""
|
||||
with kb.connect_closing() as conn:
|
||||
tid = _running_task(conn)
|
||||
assert kb.block_task(conn, tid, reason="legacy")
|
||||
t = kb.get_task(conn, tid)
|
||||
assert t.status == "blocked"
|
||||
assert t.block_kind is None
|
||||
|
|
@ -186,8 +186,8 @@ async def test_notifier_second_blocked_delivers(kanban_home):
|
|||
tid = kb.create_task(conn, title="test task", assignee="worker1")
|
||||
kb.add_notify_sub(conn, task_id=tid, platform="telegram", chat_id="chat1")
|
||||
|
||||
# Cycle 1: blocked
|
||||
kb.block_task(conn, tid, reason="first block")
|
||||
# Cycle 1: blocked for one reason
|
||||
kb.block_task(conn, tid, reason="first block", kind="needs_input")
|
||||
finally:
|
||||
conn.close()
|
||||
|
||||
|
|
@ -197,14 +197,18 @@ async def test_notifier_second_blocked_delivers(kanban_home):
|
|||
timeout=10.0,
|
||||
)
|
||||
|
||||
# Cycle 2: unblock → block run again
|
||||
# Cycle 2: unblock → block again for a DIFFERENT reason. A distinct
|
||||
# block cause must still notify. (A *same*-cause re-block instead trips
|
||||
# the unblock-loop breaker and routes to triage — covered by
|
||||
# test_kanban_block_kinds.py; here we exercise two genuinely different
|
||||
# blocks, which is the case the user wants notified twice.)
|
||||
runner._running = True
|
||||
tick_count = 0
|
||||
|
||||
conn = kb.connect()
|
||||
try:
|
||||
kb.unblock_task(conn, tid)
|
||||
kb.block_task(conn, tid, reason="second block")
|
||||
kb.block_task(conn, tid, reason="second block", kind="capability")
|
||||
finally:
|
||||
conn.close()
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue