mirror of
https://github.com/rennf93/roboco.git
synced 2026-08-03 07:23:24 +02:00
Post-audit sweep over the 135 audit-fix commits since19a474d3: 1. Stripped every # Fxxx: audit-ID token from comments AND every Fxxx token from docstring openings across 211 blocks / ~626 lines. The CEO flagged these twice: audit-issue IDs in code confuse future devs/agents. The descriptive text is preserved; only the Fxxx token is removed (and bloated narrative blocks trimmed to 1-3 lines keeping the one non-obvious invariant). 2. Trimmed bloated comments/docstrings to the concise standard (1-3 lines). 3. Added missing behavior-change docs for the audit-fix batch: prompts/roles (documenter, pr_reviewer, qa), user-facing docs (api auth, websockets, agent-gateway, megatask, merge-model, task-lifecycle, grok, resilience, conventions, panel, security, troubleshooting), and the RAG corpus (cell-pm, main-pm, pr-reviewer, qa roles; conventions; messaging-tools; escalation; megatask; task-claiming workflows). Comment/docstring/prose ONLY — zero code-line edits (verified: the diff contains no def/class/return/if/for/await/assignment/call lines). Gates green: ruff format + ruff check clean, mypy clean on roboco/. The only pytest failures are the pre-existing sync_branch tracing-decision gap (B1,250be5c2) — not sweep-caused and tracked separately.
555 lines
22 KiB
Python
555 lines
22 KiB
Python
"""
|
|
Notification Service
|
|
|
|
Sends notifications through the API with proper enforcement.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any
|
|
from uuid import UUID
|
|
|
|
import structlog
|
|
from sqlalchemy import select
|
|
|
|
from roboco.db.base import get_db_context
|
|
from roboco.db.tables import AgentTable, NotificationTable
|
|
from roboco.foundation.policy.communications import ACK_REQUIRED_BY_TYPE
|
|
from roboco.models import NotificationPriority, NotificationType
|
|
from roboco.models.notification import CreateNotificationParams
|
|
from roboco.utils.converters import require_uuid
|
|
|
|
if TYPE_CHECKING:
|
|
from sqlalchemy.ext.asyncio import AsyncSession
|
|
|
|
logger = structlog.get_logger()
|
|
|
|
|
|
async def _resolve_agent_uuid(
|
|
db: AsyncSession, value: str | UUID | None
|
|
) -> UUID | None:
|
|
"""Turn an agent slug or UUID (any case / any form) into a real UUID.
|
|
|
|
`notifications.from_agent` is UUID-typed in the DB + FK to agents.id.
|
|
Callers across the codebase pass slugs ("be-doc", "system", etc.) —
|
|
this resolver does the slug→UUID translation. "system" resolves to
|
|
the seeded system agent (stable UUID) so orchestrator-generated
|
|
notifications always have a valid sender.
|
|
|
|
Returns None only for truly absent values (None, empty string, or a
|
|
slug we can't find). The caller in `_create_notification` logs +
|
|
skips in that case rather than crashing on FK violation.
|
|
"""
|
|
if value is None or value == "":
|
|
return None
|
|
if isinstance(value, UUID):
|
|
return value
|
|
try:
|
|
return UUID(str(value))
|
|
except ValueError:
|
|
pass
|
|
result = await db.execute(select(AgentTable).where(AgentTable.slug == str(value)))
|
|
agent = result.scalar_one_or_none()
|
|
return UUID(str(agent.id)) if agent else None
|
|
|
|
|
|
class NotificationService:
|
|
"""Service for sending system-generated notifications."""
|
|
|
|
async def send_blocker_notification(
|
|
self,
|
|
task_id: str,
|
|
blocker_reason: str,
|
|
from_agent: str | None,
|
|
to_pm: str,
|
|
) -> None:
|
|
"""Send notification about a blocked task."""
|
|
logger.info(
|
|
"Sending blocker notification",
|
|
task_id=task_id,
|
|
to_pm=to_pm,
|
|
)
|
|
|
|
# System notifications bypass normal permission checks
|
|
body = (
|
|
f"Task {task_id} has been blocked.\n\n"
|
|
f"Reason: {blocker_reason}\n\n"
|
|
"Please investigate and help resolve."
|
|
)
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.BLOCKER_ESCALATION,
|
|
priority=NotificationPriority.HIGH,
|
|
from_agent=from_agent or "system",
|
|
to_agents=[to_pm],
|
|
subject=f"Task {task_id} is blocked",
|
|
body=body,
|
|
related_task_id=task_id,
|
|
)
|
|
)
|
|
|
|
async def send_stuck_agent_notification(
|
|
self,
|
|
task_id: str,
|
|
agent_slug: str,
|
|
task_status: str,
|
|
to_agent: str,
|
|
) -> None:
|
|
"""Alert an overseer that an agent is wedged in an unproductive loop.
|
|
|
|
Raised when the dispatcher's respawn circuit-breaker pauses further
|
|
spawns: the agent was respawned repeatedly without advancing the task,
|
|
so automatic recovery has given up and a human needs to intervene.
|
|
"""
|
|
logger.info(
|
|
"Sending stuck-agent notification",
|
|
task_id=task_id,
|
|
agent=agent_slug,
|
|
to_agent=to_agent,
|
|
)
|
|
body = (
|
|
f"Agent {agent_slug} was repeatedly spawned on task {task_id} "
|
|
f"(status: {task_status}) without advancing it, so further automatic "
|
|
"spawns have been paused. Please investigate and intervene manually."
|
|
)
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.BLOCKER_ESCALATION,
|
|
priority=NotificationPriority.HIGH,
|
|
from_agent="system",
|
|
to_agents=[to_agent],
|
|
subject=f"Agent {agent_slug} stuck on task {task_id}",
|
|
body=body,
|
|
related_task_id=task_id,
|
|
)
|
|
)
|
|
|
|
async def send_qa_ready_notification(
|
|
self,
|
|
task_id: str,
|
|
from_agent: str | None,
|
|
to_qa: str,
|
|
) -> None:
|
|
"""Send notification that task is ready for QA."""
|
|
logger.info(
|
|
"Sending QA ready notification",
|
|
task_id=task_id,
|
|
to_qa=to_qa,
|
|
)
|
|
|
|
body = (
|
|
f"Task {task_id} is ready for QA review.\n\n"
|
|
"Please review and provide feedback."
|
|
)
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.REVIEW_REQUEST,
|
|
priority=NotificationPriority.NORMAL,
|
|
from_agent=from_agent or "system",
|
|
to_agents=[to_qa],
|
|
subject=f"Task {task_id} ready for QA",
|
|
body=body,
|
|
related_task_id=task_id,
|
|
)
|
|
)
|
|
|
|
async def send_docs_ready_notification(
|
|
self,
|
|
task_id: str,
|
|
from_agent: str | None,
|
|
to_documenter: str,
|
|
) -> None:
|
|
"""Send notification that task is ready for documentation."""
|
|
logger.info(
|
|
"Sending docs ready notification",
|
|
task_id=task_id,
|
|
to_documenter=to_documenter,
|
|
)
|
|
|
|
body = (
|
|
f"Task {task_id} has passed QA and is ready for documentation.\n\n"
|
|
"Please create the required documentation."
|
|
)
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.DOCUMENTATION_REQUEST,
|
|
priority=NotificationPriority.NORMAL,
|
|
from_agent=from_agent or "system",
|
|
to_agents=[to_documenter],
|
|
subject=f"Task {task_id} needs documentation",
|
|
body=body,
|
|
related_task_id=task_id,
|
|
)
|
|
)
|
|
|
|
async def send_handoff_notification(
|
|
self,
|
|
task_id: str,
|
|
handoff_id: str,
|
|
from_agent: str | None,
|
|
to_documenter: str,
|
|
) -> None:
|
|
"""Send notification that task needs handoff documentation."""
|
|
logger.info(
|
|
"Sending handoff notification",
|
|
task_id=task_id,
|
|
handoff_id=handoff_id,
|
|
to_documenter=to_documenter,
|
|
)
|
|
|
|
body = (
|
|
f"Task {task_id} is ready for handoff (ID: {handoff_id}).\n\n"
|
|
"Please review and create handoff documentation."
|
|
)
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.DOCUMENTATION_REQUEST,
|
|
priority=NotificationPriority.NORMAL,
|
|
from_agent=from_agent or "system",
|
|
to_agents=[to_documenter],
|
|
subject=f"Handoff required: Task {task_id}",
|
|
body=body,
|
|
related_task_id=task_id,
|
|
)
|
|
)
|
|
|
|
async def send_qa_failed_notification(
|
|
self,
|
|
task_id: str,
|
|
qa_notes: str,
|
|
to_developer: str,
|
|
) -> None:
|
|
"""Send notification that task failed QA."""
|
|
logger.info(
|
|
"Sending QA failed notification",
|
|
task_id=task_id,
|
|
to_developer=to_developer,
|
|
)
|
|
|
|
body = (
|
|
f"Task {task_id} has failed QA review.\n\n"
|
|
f"Notes: {qa_notes}\n\n"
|
|
"Please address the issues and resubmit."
|
|
)
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.REVIEW_REQUEST,
|
|
priority=NotificationPriority.HIGH,
|
|
from_agent="system",
|
|
to_agents=[to_developer],
|
|
subject=f"QA Failed: Task {task_id}",
|
|
body=body,
|
|
related_task_id=task_id,
|
|
)
|
|
)
|
|
|
|
async def send_board_review_complete_notification(
|
|
self,
|
|
task_id: str,
|
|
from_agent: str | None = None,
|
|
to_ceo: str = "ceo",
|
|
) -> None:
|
|
"""Tell the CEO a board review is complete and ready for Approve & Start.
|
|
|
|
Board-reviewed coordination tasks stay ``pending`` and wait for the
|
|
CEO's Approve & Start gate (``TaskService.approve_and_start``). The
|
|
Product Owner + Head of Marketing record their review via channel
|
|
dialogue and journal notes, but that left the CEO with no actionable
|
|
signal — only buried chatter. This emits a
|
|
formal APPROVAL notification (ack-required) carrying ``related_task_id``
|
|
so the handoff is a real signal the panel can surface, not channel
|
|
noise. Board roles are exactly the senders permitted to notify, so the
|
|
orchestrator emits it as ``system`` on their behalf once BOTH board
|
|
reviewers (PO + Head of Marketing) have finished.
|
|
"""
|
|
logger.info(
|
|
"Sending board-review-complete notification to CEO",
|
|
task_id=task_id,
|
|
to_ceo=to_ceo,
|
|
)
|
|
|
|
body = (
|
|
f"Board review complete for task {task_id}.\n\n"
|
|
"The Product Owner and Head of Marketing have both reviewed and "
|
|
"recorded their requirements. The task is ready for your "
|
|
"Approve & Start decision (hand to Main PM) or rejection."
|
|
)
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.APPROVAL,
|
|
priority=NotificationPriority.HIGH,
|
|
from_agent=from_agent or "system",
|
|
to_agents=[to_ceo],
|
|
subject=f"Board review complete: Task {task_id}",
|
|
body=body,
|
|
related_task_id=task_id,
|
|
)
|
|
)
|
|
|
|
async def send_external_pr_reviewed_notification(
|
|
self,
|
|
task_id: str,
|
|
pr_number: int,
|
|
pr_url: str,
|
|
from_agent: str | None = None,
|
|
to_ceo: str = "ceo",
|
|
) -> None:
|
|
"""Tell the CEO an inbound external PR has been reviewed — their call.
|
|
|
|
The PR reviewer is read-only: it posts one change-request and stops. The
|
|
CEO is the gate on what happens next (supersede the PR — the org takes it
|
|
over and finishes it — or dismiss it). A passive ping is not enough, so
|
|
this emits a formal APPROVAL notification carrying ``related_task_id`` so
|
|
the panel's PR-review decision queue can surface it as an actionable
|
|
signal. Emitted server-side as ``system`` (the reviewer has no notify
|
|
verb).
|
|
"""
|
|
logger.info(
|
|
"Sending external-PR-reviewed notification to CEO",
|
|
task_id=task_id,
|
|
pr_number=pr_number,
|
|
to_ceo=to_ceo,
|
|
)
|
|
body = (
|
|
f"External PR #{pr_number} has been reviewed and a change-request "
|
|
f"posted ({pr_url}).\n\nYour call: supersede it (the org takes the "
|
|
"contribution over and finishes it to our standards) or dismiss it."
|
|
)
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.APPROVAL,
|
|
priority=NotificationPriority.HIGH,
|
|
from_agent=from_agent or "system",
|
|
to_agents=[to_ceo],
|
|
subject=f"External PR #{pr_number} reviewed — your decision",
|
|
body=body,
|
|
related_task_id=task_id,
|
|
)
|
|
)
|
|
|
|
async def send_ack_notification(
|
|
self,
|
|
*,
|
|
from_agent: UUID | str,
|
|
to_agent: str,
|
|
body: str,
|
|
priority: NotificationPriority = NotificationPriority.NORMAL,
|
|
task_id: UUID | str | None = None,
|
|
) -> None:
|
|
"""Send a free-form ack-required notification (PM/Board only).
|
|
|
|
Used by the gateway `notify` content-tool. Distinguishes from
|
|
the typed `send_*_notification` helpers above, which carry
|
|
lifecycle semantics (blocker, qa-ready, etc.). Here the caller
|
|
supplies the body verbatim. ALERT type is used so consumers
|
|
treat it as a high-attention formal signal rather than
|
|
conflating with task-state-driven notifications. The subject
|
|
is derived from the first line of `body` (truncated), matching
|
|
how `say`/`dm` derive a subject from free text.
|
|
"""
|
|
subject = body.split("\n", 1)[0][:200] or "Notification"
|
|
related_task_id = str(task_id) if task_id is not None else None
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.ALERT,
|
|
priority=priority,
|
|
from_agent=str(from_agent),
|
|
to_agents=[to_agent],
|
|
subject=subject,
|
|
body=body,
|
|
related_task_id=related_task_id,
|
|
)
|
|
)
|
|
|
|
async def send_a2a_notification(
|
|
self,
|
|
task_id: str,
|
|
a2a_context: dict[str, Any],
|
|
) -> None:
|
|
"""Send notification for A2A request (when recipient is busy or offline).
|
|
|
|
Args:
|
|
task_id: Related task ID
|
|
a2a_context: Dict with from_agent, to_agent, skill, message,
|
|
priority. `priority` is a `NotificationPriority` (full
|
|
tristate: NORMAL / HIGH / URGENT). This key used to be
|
|
`urgent: bool`, which collapsed HIGH to NORMAL —
|
|
A2AService now sends Priority directly.
|
|
"""
|
|
from_agent = a2a_context.get("from_agent", "unknown")
|
|
to_agent = a2a_context.get("to_agent", "")
|
|
skill = a2a_context.get("skill", "general")
|
|
message = a2a_context.get("message", "")
|
|
priority = a2a_context.get("priority", NotificationPriority.NORMAL)
|
|
# Defensive coerce — accept enum, str, or a stray bool from a
|
|
# legacy caller. The point is that HIGH survives, so only collapse
|
|
# to URGENT/NORMAL if the input is genuinely a bool.
|
|
if isinstance(priority, bool):
|
|
priority = (
|
|
NotificationPriority.URGENT if priority else NotificationPriority.NORMAL
|
|
)
|
|
elif not isinstance(priority, NotificationPriority):
|
|
try:
|
|
priority = NotificationPriority(str(priority))
|
|
except ValueError:
|
|
priority = NotificationPriority.NORMAL
|
|
|
|
logger.info(
|
|
"Sending A2A notification",
|
|
task_id=task_id,
|
|
from_agent=from_agent,
|
|
to_agent=to_agent,
|
|
skill=skill,
|
|
priority=priority.value,
|
|
)
|
|
|
|
# Cosmetic [URGENT] prefix stays urgent-only. HIGH is recorded at
|
|
# the NotificationTable.priority column but gets no body/subject
|
|
# prefix — the column is the source of truth for routing, the
|
|
# label is just an attention hint for the human-readable body.
|
|
urgency_label = "[URGENT] " if priority == NotificationPriority.URGENT else ""
|
|
body = (
|
|
f"{urgency_label}A2A request from {from_agent}.\n\n"
|
|
f"Skill: {skill}\n\n"
|
|
f"Message: {message}"
|
|
)
|
|
await self._create_notification(
|
|
CreateNotificationParams(
|
|
notification_type=NotificationType.A2A_REQUEST,
|
|
priority=priority,
|
|
from_agent=from_agent,
|
|
to_agents=[to_agent],
|
|
subject=f"{urgency_label}A2A: {skill}",
|
|
body=body,
|
|
related_task_id=task_id,
|
|
)
|
|
)
|
|
|
|
@staticmethod
|
|
def _notification_type_label(params: CreateNotificationParams) -> str:
|
|
"""Render the notification_type for a log line."""
|
|
nt = params.notification_type
|
|
return nt.value if hasattr(nt, "value") else str(nt)
|
|
|
|
async def _resolve_recipients(
|
|
self, db: Any, params: CreateNotificationParams
|
|
) -> list[UUID]:
|
|
"""Resolve to_agents (slugs/UUIDs) to UUID list. Drops unresolvable.
|
|
|
|
notifications.to_agents is UUID[] — callers across the codebase
|
|
pass slugs ("be-dev-1", "be-qa"). Resolve every recipient before
|
|
insert; drop (with warn) any that don't resolve instead of
|
|
letting asyncpg crash with "invalid UUID 'be-dev-1'".
|
|
"""
|
|
to_agents_uuids: list[UUID] = []
|
|
unresolved: list[str] = []
|
|
for recipient in params.to_agents:
|
|
resolved = await _resolve_agent_uuid(db, recipient)
|
|
if resolved is None:
|
|
unresolved.append(str(recipient))
|
|
else:
|
|
to_agents_uuids.append(resolved)
|
|
if unresolved:
|
|
logger.warning(
|
|
"Dropping unresolved notification recipients",
|
|
unresolved=unresolved,
|
|
type=self._notification_type_label(params),
|
|
subject=params.subject[:80],
|
|
)
|
|
return to_agents_uuids
|
|
|
|
async def _create_notification(self, params: CreateNotificationParams) -> None:
|
|
"""Create a notification via the database and deliver it."""
|
|
async with get_db_context() as db:
|
|
from_agent_uuid = await _resolve_agent_uuid(db, params.from_agent)
|
|
if from_agent_uuid is None:
|
|
# notifications.from_agent is NOT NULL + FK to agents.id, so
|
|
# we cannot insert. Skip-with-warn rather than crash the
|
|
# upstream request.
|
|
logger.warning(
|
|
"Skipping notification: from_agent unresolvable",
|
|
from_agent_input=str(params.from_agent),
|
|
type=self._notification_type_label(params),
|
|
subject=params.subject[:80],
|
|
to_agents=[str(a) for a in params.to_agents],
|
|
)
|
|
return
|
|
to_agents_uuids = await self._resolve_recipients(db, params)
|
|
if not to_agents_uuids:
|
|
logger.warning(
|
|
"Skipping notification: no resolvable recipients",
|
|
to_agents_input=[str(a) for a in params.to_agents],
|
|
type=self._notification_type_label(params),
|
|
subject=params.subject[:80],
|
|
)
|
|
return
|
|
# Purpose-based dedup (CEO directive, 2026-06-10): do NOT create a
|
|
# second notification for the SAME purpose — same sender, same type,
|
|
# same task, overlapping recipients — while a prior one is still
|
|
# unacknowledged. Agents loop and re-send the same signal (often
|
|
# reworded); each copy inflates the recipient's unacked set, which
|
|
# soft-blocks their i_am_idle and drives respawn churn. A different
|
|
# type, a different task, a different sender, or a recipient who has
|
|
# already acked all go through. Body text is NOT compared, so
|
|
# rewording cannot defeat the guard.
|
|
#
|
|
# Dedup only applies to ACTION-REQUIRED types; informational types
|
|
# carry distinct content per send and acking is voluntary, so
|
|
# deduping them would silently drop broadcasts.
|
|
related = params.related_task_id
|
|
is_ack_required = ACK_REQUIRED_BY_TYPE.get(params.notification_type, True)
|
|
if is_ack_required:
|
|
dup_q = (
|
|
select(NotificationTable.id)
|
|
.where(NotificationTable.from_agent == from_agent_uuid)
|
|
.where(NotificationTable.type == params.notification_type)
|
|
.where(NotificationTable.to_agents.overlap(to_agents_uuids))
|
|
.where(~NotificationTable.acked_by.contains(to_agents_uuids))
|
|
.where(
|
|
NotificationTable.related_task_id == related
|
|
if related is not None
|
|
else NotificationTable.related_task_id.is_(None)
|
|
)
|
|
.limit(1)
|
|
)
|
|
if await db.scalar(dup_q) is not None:
|
|
logger.info(
|
|
"Suppressed duplicate notification (same purpose, unacked)",
|
|
from_agent=str(from_agent_uuid),
|
|
type=params.notification_type.value,
|
|
related_task_id=str(related) if related is not None else None,
|
|
to_agents=[str(a) for a in to_agents_uuids],
|
|
)
|
|
return
|
|
notification = NotificationTable(
|
|
type=params.notification_type,
|
|
priority=params.priority,
|
|
from_agent=from_agent_uuid,
|
|
to_agents=to_agents_uuids,
|
|
subject=params.subject,
|
|
body=params.body,
|
|
related_task_id=params.related_task_id,
|
|
# requires_ack follows ACK_REQUIRED_BY_TYPE (action-required vs
|
|
# informational), not the column's True default; default True
|
|
# for an unmapped type preserves the safe action-required bias.
|
|
requires_ack=ACK_REQUIRED_BY_TYPE.get(params.notification_type, True),
|
|
)
|
|
db.add(notification)
|
|
await db.flush()
|
|
|
|
# Deliver via Redis Streams for real-time push
|
|
from roboco.services.notification_delivery import (
|
|
get_notification_delivery_service,
|
|
)
|
|
|
|
delivery_service = get_notification_delivery_service(db)
|
|
await delivery_service.deliver(require_uuid(notification.id))
|
|
|
|
await db.commit()
|
|
|
|
logger.info(
|
|
"Notification created and delivered",
|
|
notification_id=str(notification.id),
|
|
type=params.notification_type.value,
|
|
)
|