Files
roboco/tests/unit/services/test_worktree_cleanup_on_complete.py
T
93739a9dca fix(notifications): stop tick-wide row locks + poisoned-session swallows behind the PendingRollbackError 500s (#743)
* fix(notifications): release re-escalation row locks per row; stop swallowing DB errors in notify_get

The re-escalation sweep ran one tick-wide transaction, so each CAS
claim's row lock was held across every remaining delivery until the
single commit — a concurrent mark-read UPDATE on a claimed row starved
into the 60s lock_timeout. The sweep now commits per row (claim commit
releases the lock before delivery and makes the burned slot durable),
re-fetches each row by snapshotted id so one row's rollback can't
expire the rest of the tick, and savepoints each recipient's delivery.

notify_get's bare except swallowed the resulting LockNotAvailableError
into a false "notification not found" and returned a poisoned session
to the commit-at-send middleware, which blew up with
PendingRollbackError; it now catches only the two domain outcomes.

defer_after_commit's listeners fire on SAVEPOINT release too, which
would have drained deferred telegram/bus work before real durability —
they now skip savepoint boundaries via get_nested_transaction() (the
root get_transaction() is non-None inside the listener even at a real
commit). acknowledge_for_recipient's Redis dedup-clear moved before the
flush so the row lock never spans a Redis round-trip. The five
best-effort CEO-notify swallows that persist notification rows are
savepointed.

* fix(services): contain swallowed best-effort DB write failures instead of poisoning the session

Sweep of the same class as the notify_get incident: broad
except-Exception handlers that swallow a failure whose try-body writes
through the shared session leave the session rollback-pending, and the
verb/request then dies later with PendingRollbackError at
commit-at-send. Confirmed-dangerous sites now run the write inside a
savepoint (safe since defer_after_commit skips savepoint boundaries):
ceo_approve's verified-stamp, completion/pitch/postmortem-style CEO
notifies, _inherit_upstream_base, _link_commit_to_task (covers every
commit route), board-program LEARN records, the QA/PR-gate/PM-merge
verified-stamps, and the documenter->PM handoff.
_ack_pending_wake_notifications gets the same treatment so a wake-ack
failure can't fail the A2A read. telegram_inbound's per-update loop and
intake confirm roll back explicitly instead (their success paths commit
mid-flow, so a savepoint doesn't fit).

A swallowed savepoint rollback fully expires any ORM object mutated
inside the block, and the next attribute read raises MissingGreenlet —
strictly worse than the original bug. The two paths that keep using the
object after the swallow (doc handoff's envelope build, base
inheritance's claim continuation) refresh it in the except path;
regression tests run against a real session and were verified to fail
with the refresh reverted.

* test: shape mocked session.execute results so sync accessors stop leaking unawaited coroutines

An AsyncMock's auto-created children are themselves AsyncMock, so
production code that correctly awaits session.execute() and then calls
sync accessors (.scalars().all(), .scalar_one_or_none()) on the result
was silently collecting unawaited coroutines in 22 test files — 80
RuntimeWarnings per unit run, and in test_flow_soup_guard one mock
raised a real TypeError that a coincidentally-matching invalid_state
envelope masked. Each affected fixture now returns a plain MagicMock
shaped like a real Result. Zero AsyncMock warnings remain.

* docs: document per-row sweep commits and the savepoint/refresh containment pattern

---------

Co-authored-by: Renn F <rennf93@users.noreply.github.com>
2026-07-30 16:35:42 +02:00

320 lines
13 KiB
Python

"""Terminal worktree cleanup on complete/ceo_approve (F123 followup).
Completed/merged tasks must not leak their per-task worktree on disk until the
whole agent is deleted. The two terminal→completed paths (cell-PM ``complete``
after the leaf PR merges; CEO ``ceo_approve`` after root→master merges) remove
the assignee's worktree best-effort. Removal is terminal-only — a dev task
bounces ``needs_revision`` off the earlier review states and needs its worktree
back, so cleanup fires only at ``completed`` (post-merge, branch truly done).
No-op for branchless tasks (no worktree was ever cut). Best-effort: a removal
failure never blocks completion.
"""
from __future__ import annotations
from unittest.mock import AsyncMock, MagicMock, patch
from uuid import uuid4
import pytest
from roboco.models.base import TaskStatus
from roboco.services.task import TaskService
def _build_task(**overrides: object) -> MagicMock:
base: dict[str, object] = {
"id": uuid4(),
"status": TaskStatus.PENDING,
"branch_name": "feature/backend/abc12345",
"work_session_id": None,
"assigned_to": None,
}
base.update(overrides)
return MagicMock(**base)
def _bind(svc: TaskService, name: str, value: object) -> None:
object.__setattr__(svc, name, value)
def _slug_row(slug: str) -> MagicMock:
return MagicMock(scalar_one_or_none=MagicMock(return_value=slug))
def _empty_result() -> MagicMock:
"""A `session.execute(...)` result shaped for every sync accessor real
code calls on it (`.scalar_one_or_none()`, `.one_or_none()`,
`.scalars().all()`) — all "nothing found" defaults. A bare unconfigured
`AsyncMock()` leaks an unawaited coroutine on each of those (its
attributes are AsyncMock too, unlike MagicMock's), and a plain
`MagicMock()`'s `.scalar_one_or_none()`/`.one_or_none()` would each
default to a truthy MagicMock instead of the `None` real callers here
(`_get_ceo_agent`, `MetricsService.get_task_metrics`) treat as "not
found"."""
result = MagicMock()
result.scalar_one_or_none.return_value = None
result.one_or_none.return_value = None
result.scalars.return_value.all.return_value = []
return result
def _svc(execute: object) -> tuple[TaskService, MagicMock]:
# Build the session as a local MagicMock and preset `execute` on it before
# handing it to TaskService — assigning to `svc.session.execute` directly
# trips mypy's method-assign (session is typed as a real AsyncSession).
session = MagicMock()
session.execute = execute
session.flush = AsyncMock()
return TaskService(session), session
# ---------------------------------------------------------------------------
# complete (cell PM, awaiting_pm_review -> completed, after leaf PR merge)
# ---------------------------------------------------------------------------
@pytest.mark.asyncio
async def test_complete_removes_assignee_worktree_best_effort() -> None:
task = _build_task(status=TaskStatus.AWAITING_PM_REVIEW)
svc, _ = _svc(AsyncMock(return_value=_slug_row("roboco-api")))
_bind(svc, "get", AsyncMock(return_value=task))
_bind(svc, "_get_completing_agent_role", AsyncMock(return_value="cell_pm"))
_bind(svc, "_validate_completion_prerequisites", AsyncMock(return_value=[]))
_bind(svc, "_apply_complete_approval_chain", AsyncMock(return_value=None))
_bind(svc, "_cancelled_force_allowed", MagicMock(return_value=True))
_bind(svc, "_assert_pr_merged_for_complete", AsyncMock(return_value=True))
_bind(svc, "_validate_and_set_status", MagicMock())
_bind(svc, "_close_work_session_for_task", AsyncMock())
_bind(svc, "_trigger_completion_hooks", AsyncMock())
_bind(svc, "_unblock_dependents", AsyncMock())
remove = AsyncMock()
_bind(svc, "_remove_task_worktree_best_effort", remove)
result = await svc.complete(task.id)
assert result is task
remove.assert_awaited_once_with(task, "roboco-api", force_branch_delete=True)
@pytest.mark.asyncio
async def test_complete_skips_worktree_cleanup_for_branchless_task() -> None:
# A branchless/umbrella task had no worktree cut — removal must be a no-op
# (and must not even probe the project slug).
task = _build_task(status=TaskStatus.AWAITING_PM_REVIEW, branch_name=None)
execute = AsyncMock()
svc, session = _svc(execute)
_bind(svc, "get", AsyncMock(return_value=task))
_bind(svc, "_get_completing_agent_role", AsyncMock(return_value="cell_pm"))
_bind(svc, "_validate_completion_prerequisites", AsyncMock(return_value=[]))
_bind(svc, "_apply_complete_approval_chain", AsyncMock(return_value=None))
_bind(svc, "_cancelled_force_allowed", MagicMock(return_value=True))
_bind(svc, "_assert_pr_merged_for_complete", AsyncMock(return_value=True))
_bind(svc, "_validate_and_set_status", MagicMock())
_bind(svc, "_close_work_session_for_task", AsyncMock())
_bind(svc, "_trigger_completion_hooks", AsyncMock())
_bind(svc, "_unblock_dependents", AsyncMock())
remove = AsyncMock()
_bind(svc, "_remove_task_worktree_best_effort", remove)
result = await svc.complete(task.id)
assert result is task
remove.assert_not_awaited()
session.execute.assert_not_awaited()
@pytest.mark.asyncio
async def test_complete_not_blocked_by_worktree_removal_failure() -> None:
# Best-effort: a git/FS failure during cleanup must NOT fail the completion.
task = _build_task(status=TaskStatus.AWAITING_PM_REVIEW)
svc, _ = _svc(AsyncMock(return_value=_slug_row("roboco-api")))
_bind(svc, "get", AsyncMock(return_value=task))
_bind(svc, "_get_completing_agent_role", AsyncMock(return_value="cell_pm"))
_bind(svc, "_validate_completion_prerequisites", AsyncMock(return_value=[]))
_bind(svc, "_apply_complete_approval_chain", AsyncMock(return_value=None))
_bind(svc, "_cancelled_force_allowed", MagicMock(return_value=True))
_bind(svc, "_assert_pr_merged_for_complete", AsyncMock(return_value=True))
_bind(svc, "_validate_and_set_status", MagicMock())
_bind(svc, "_close_work_session_for_task", AsyncMock())
_bind(svc, "_trigger_completion_hooks", AsyncMock())
_bind(svc, "_unblock_dependents", AsyncMock())
remove = AsyncMock(side_effect=RuntimeError("git worktree remove failed"))
_bind(svc, "_remove_task_worktree_best_effort", remove)
result = await svc.complete(task.id)
assert result is task # completion still succeeds
# ---------------------------------------------------------------------------
# ceo_approve (CEO, awaiting_ceo_approval -> completed, after root->master merge)
# ---------------------------------------------------------------------------
@pytest.mark.asyncio
async def test_ceo_approve_removes_assignee_worktree_best_effort() -> None:
task = _build_task(status=TaskStatus.AWAITING_CEO_APPROVAL, work_session_id=None)
svc, _ = _svc(AsyncMock(return_value=_slug_row("roboco-api")))
_bind(svc, "get", AsyncMock(return_value=task))
_bind(svc, "_validate_and_set_status", MagicMock())
_bind(svc, "_close_work_session_for_task", AsyncMock())
_bind(svc, "_trigger_completion_hooks", AsyncMock())
_bind(svc, "_unblock_dependents", AsyncMock())
_bind(svc, "_emit_task_event", AsyncMock())
remove = AsyncMock()
_bind(svc, "_remove_task_worktree_best_effort", remove)
result = await svc.ceo_approve(task.id)
assert result is task
remove.assert_awaited_once_with(task, "roboco-api", force_branch_delete=True)
@pytest.mark.asyncio
async def test_ceo_approve_skips_worktree_cleanup_for_branchless_task() -> None:
task = _build_task(status=TaskStatus.AWAITING_CEO_APPROVAL, branch_name=None)
svc, _ = _svc(AsyncMock(return_value=_empty_result()))
_bind(svc, "get", AsyncMock(return_value=task))
_bind(svc, "_validate_and_set_status", MagicMock())
_bind(svc, "_close_work_session_for_task", AsyncMock())
_bind(svc, "_trigger_completion_hooks", AsyncMock())
_bind(svc, "_unblock_dependents", AsyncMock())
_bind(svc, "_emit_task_event", AsyncMock())
remove = AsyncMock()
_bind(svc, "_remove_task_worktree_best_effort", remove)
result = await svc.ceo_approve(task.id)
assert result is task
remove.assert_not_awaited()
@pytest.mark.asyncio
async def test_ceo_approve_closes_work_session_and_triggers_completion_hooks() -> None:
"""#21/#98: ceo_approve must close the work session and run the full
completion-hook fan-out (commits + dev_notes indexing), mirroring
``complete()`` — not hand-roll a lone learnings task and leave the work
session ACTIVE forever. The PR-merged gate already ran above."""
task = _build_task(status=TaskStatus.AWAITING_CEO_APPROVAL, work_session_id=None)
svc, _ = _svc(AsyncMock(return_value=_slug_row("roboco-api")))
_bind(svc, "get", AsyncMock(return_value=task))
_bind(svc, "_validate_and_set_status", MagicMock())
close_ws = AsyncMock()
hooks = AsyncMock()
_bind(svc, "_close_work_session_for_task", close_ws)
_bind(svc, "_trigger_completion_hooks", hooks)
_bind(svc, "_unblock_dependents", AsyncMock())
_bind(svc, "_emit_task_event", AsyncMock())
_bind(svc, "_remove_task_worktree_best_effort", AsyncMock())
result = await svc.ceo_approve(task.id)
assert result is task
close_ws.assert_awaited_once()
# The hooks fire with the CEO actor (None) — same as complete() for a
# non-agent completion path.
hooks.assert_awaited_once_with(task, None)
# ---------------------------------------------------------------------------
# #216: recurring FS/permission cleanup failure escalates to the CEO
# ---------------------------------------------------------------------------
def _reset_cleanup_streak() -> None:
TaskService._worktree_cleanup_fail_streak = 0
TaskService._worktree_cleanup_escalated = False
@pytest.mark.asyncio
async def test_recurring_worktree_cleanup_failure_escalates_to_ceo() -> None:
"""#216: a recurring FS/permission failure (stuck mount, perms) used to
leak worktrees indefinitely with only a warning log. After N consecutive
OSError failures a CEO alert fires once; further failures are suppressed
until a success resets the streak."""
_reset_cleanup_streak()
n = TaskService._WORKTREE_CLEANUP_ESCALATE_AFTER
task = _build_task(status=TaskStatus.COMPLETED)
svc, _ = _svc(AsyncMock(return_value=_slug_row("roboco-api")))
_bind(
svc,
"_remove_task_worktree_best_effort",
AsyncMock(side_effect=PermissionError("denied")),
)
with patch(
"roboco.services.notification.NotificationService.send_ack_notification",
new=AsyncMock(),
) as notifier:
for _ in range(n - 1):
await svc._remove_task_worktree_on_terminal(task)
notifier.assert_not_awaited()
await svc._remove_task_worktree_on_terminal(task) # Nth failure
notifier.assert_awaited_once()
call = notifier.await_args
assert call is not None
assert call.kwargs["to_agent"] == "ceo"
assert str(task.id) in str(call.kwargs.get("task_id") or call.args)
# Suppressed on the (N+1)th — one escalation per failure streak.
await svc._remove_task_worktree_on_terminal(task)
notifier.assert_awaited_once()
_reset_cleanup_streak()
@pytest.mark.asyncio
async def test_worktree_cleanup_success_resets_failure_streak() -> None:
"""A successful cleanup resets the streak + escalation flag, so a later
failure streak must re-accumulate to the full threshold before escalating."""
_reset_cleanup_streak()
n = TaskService._WORKTREE_CLEANUP_ESCALATE_AFTER
task = _build_task(status=TaskStatus.COMPLETED)
svc, _ = _svc(AsyncMock(return_value=_slug_row("roboco-api")))
remove = AsyncMock(side_effect=PermissionError("denied"))
_bind(svc, "_remove_task_worktree_best_effort", remove)
with patch(
"roboco.services.notification.NotificationService.send_ack_notification",
new=AsyncMock(),
) as notifier:
for _ in range(n - 1):
await svc._remove_task_worktree_on_terminal(task)
notifier.assert_not_awaited()
# A success resets the streak.
remove.side_effect = None
await svc._remove_task_worktree_on_terminal(task)
# Re-introduce failures: needs a full N again, not 1.
remove.side_effect = PermissionError("denied")
for _ in range(n - 1):
await svc._remove_task_worktree_on_terminal(task)
notifier.assert_not_awaited()
await svc._remove_task_worktree_on_terminal(task) # Nth of new streak
notifier.assert_awaited_once()
_reset_cleanup_streak()
@pytest.mark.asyncio
async def test_non_fs_worktree_cleanup_failure_does_not_escalate() -> None:
"""A non-FS failure (git RuntimeError, DB error) is task-specific, not the
systemic operator-actionable FS case — it logs but never escalates, and it
resets the streak so an interleaved FS streak can't ride on it."""
_reset_cleanup_streak()
n = TaskService._WORKTREE_CLEANUP_ESCALATE_AFTER
task = _build_task(status=TaskStatus.COMPLETED)
svc, _ = _svc(AsyncMock(return_value=_slug_row("roboco-api")))
_bind(
svc,
"_remove_task_worktree_best_effort",
AsyncMock(side_effect=RuntimeError("git worktree remove failed")),
)
with patch(
"roboco.services.notification.NotificationService.send_ack_notification",
new=AsyncMock(),
) as notifier:
for _ in range(n + 2):
await svc._remove_task_worktree_on_terminal(task)
notifier.assert_not_awaited()
_reset_cleanup_streak()