Files
rengine/shared/models/notification.py
T
Yogesh OjhaandClaude Opus 5 ed5f8f3f16 feat(notifications): a notification is an interrupt, the activity log is the ledger
The in-app feed was a second copy of the activity log with a red badge on it.
A scan published up to six notifications (started, completed, new subdomains,
new services, new vulnerabilities, coverage), every one of them already an
activity_logs row and every one of them toasted for five seconds. A nightly
twenty-target schedule left forty to a hundred and twenty unread rows.

If it does not want a human to do something, it is not a notification.

Deleted scan_started, scan_completed and scan_cancelled (both the API-side echo
of the user's own Cancel click and the finalize one). whois/ripestat
enrichment_complete became enrichment_incomplete and return None unless
something actually failed.

One digest replaces the five scan templates. scan_digest(...) -> dict | None
takes a ScanDeltas and derives its severity, title, type and deep-link tab from
the worst thing inside it, and returns None when nothing changed, so a quiet
scheduled run is silent. Severity now encodes risk rather than process:
scan_failed is warning, not error, because the bell takes its colour from the
highest unread severity and one flaky run should not read like a KEV.

Toasts are interrupts only: warning and error toast, success and info land
silently in the bell. A toast with a url finally gets a View action; it used to
require an action_label no template ever set.

notifications.project_id scopes the bell to the active project (nullable and
indexed, no FK so a transient row can never block a project delete). The list,
stats, read-all and clear-all endpoints take ?project_id=, and the store drops
SSE events from other projects.

app.tasks.notifications.cleanup runs on beat every six hours. expires_at had
been decorative since nothing ever called cleanup_expired, and the inbox modal
fetched stats.total rows in a single request.

Three bugs this uncovered:

_count_new_subdomains had no baseline gate while services and vulnerabilities
did, so a target's first scan announced its whole inventory as new: the first
gov.np run would have reported 24022 new subdomains. Baselines are now per
dimension, and a run with none reports the census instead.

The delta counts ignored census_only, so a focused rescan both counted as a
baseline and had its own rows announced. Every comparison now joins
scans bs ... scope = 'full' AND bs.started_at < :started.

Measuring the deltas took 16.8s on a 13,528-host scan: the scan-level baseline
was a correlated EXISTS re-evaluated once per row and could not use
ix_subdomains_target_name_discovered, having no name predicate. Hoisting it to
one scan-level check and rewriting the per-row test as a hash anti-join over a
WITH seen AS (SELECT DISTINCT ...) CTE gives the identical answer in 52ms,
verified against a plain EXCEPT query.

Not done, deliberately: is_read is still one global flag, so on a shared
instance one analyst's Mark all as read still applies to everyone; that needs a
notification_reads table. And notifier.wants() still governs external channels
only, the bell having no preference layer, because volume reduction was the fix.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BCPTXCr5qPESCt3LxR3329
2026-09-06 18:13:08 +05:30

80 lines
2.3 KiB
Python

import uuid
from datetime import datetime, timedelta
from pydantic import BaseModel, Field, field_validator
from sqlalchemy import Text
from sqlalchemy.dialects.postgresql import JSONB
from sqlmodel import Column, SQLModel
from sqlmodel import Field as SQLField
from shared.enums.notification import NotificationSeverity, NotificationType
from shared.utils.datetime import utc_now
MAX_URL_LENGTH = 500
class NotificationMetadata(BaseModel):
url: str | None = None
open_new_tab: bool = False
scan_id: str | None = None
target_id: str | None = None
action_label: str | None = Field(default=None, max_length=50)
@field_validator("url")
@classmethod
def validate_url(cls, v: str | None) -> str | None:
if v is None:
return v
if (
not v.startswith("/")
and not v.startswith("http://")
and not v.startswith("https://")
):
msg = "URL must be relative (start with /) or absolute (http/https)"
raise ValueError(msg)
if len(v) > MAX_URL_LENGTH:
msg = f"URL too long (max {MAX_URL_LENGTH} characters)"
raise ValueError(msg)
return v
class NotificationBase(SQLModel):
type: NotificationType
severity: NotificationSeverity
title: str = SQLField(max_length=200)
message: str = SQLField(sa_column=Column(Text))
class Notification(NotificationBase, table=True):
__tablename__ = "notifications"
id: int = SQLField(default=None, primary_key=True, index=True)
project_id: uuid.UUID | None = SQLField(default=None, index=True)
notification_metadata: dict = SQLField(
default_factory=dict, sa_column=Column(JSONB)
)
is_read: bool = SQLField(default=False, index=True)
created_at: datetime = SQLField(default_factory=utc_now, index=True)
expires_at: datetime = SQLField(
default_factory=lambda: utc_now() + timedelta(days=7),
index=True,
)
class NotificationCreate(NotificationBase):
notification_metadata: NotificationMetadata | None = None
class NotificationRead(NotificationBase):
id: int
project_id: uuid.UUID | None = None
notification_metadata: dict
is_read: bool
created_at: datetime
expires_at: datetime
class NotificationStats(BaseModel):
total: int
unread: int