aboutsummaryrefslogtreecommitdiff
path: root/tests/tasks/test_notifications.py
diff options
context:
space:
mode:
authorDennis Fink2026-10-29 20:59:48 +0100
committerDennis Fink2026-10-29 20:59:48 +0100
commitedd7c0c2220ba12c2a773f9ba1cf6e0e7a273856 (patch)
treec067d16841e3d3441e3b4c6f7ed833a6d57fae04 /tests/tasks/test_notifications.py
parent9a1e863079b64883beadaba7b283621f1b3cf70a (diff)
downloadwebmentions-ssg-edd7c0c2220ba12c2a773f9ba1cf6e0e7a273856.tar.gz
webmentions-ssg-edd7c0c2220ba12c2a773f9ba1cf6e0e7a273856.zip
feat(receiver): send Webmention notification digests
Batch verified Webmention notifications into a scheduled digest so bursts of incoming mentions do not generate a separate email for every verification. Track which mentions have already been reported and leave them pending when SMTP delivery fails so a later digest can retry safely.
Diffstat (limited to '')
-rw-r--r--tests/tasks/test_notifications.py172
1 files changed, 74 insertions, 98 deletions
diff --git a/tests/tasks/test_notifications.py b/tests/tasks/test_notifications.py
index fa6ef79..f523d82 100644
--- a/tests/tasks/test_notifications.py
+++ b/tests/tasks/test_notifications.py
@@ -2,7 +2,9 @@
#
# SPDX-License-Identifier: BSD-3-Clause
+
import uuid
+from types import ModuleType
from unittest.mock import patch
import pytest
@@ -12,143 +14,117 @@ from webmentions_ssg import DATABASE as db
from webmentions_ssg.models import ReceivedWebmention
-def test_sends_email_for_verified_webmention(app: Flask) -> None:
- from webmentions_ssg.tasks.notifications import send_webmention_notification
+@pytest.fixture
+def notifications(app: Flask) -> ModuleType:
+ from webmentions_ssg.tasks import notifications
+
+ return notifications
- app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
- identifier = uuid.uuid7()
+def create_mention(app: Flask, status: str = "verified") -> uuid.UUID:
+ identifier = uuid.uuid7()
with app.app_context():
db.session.add(
ReceivedWebmention(
uuid=identifier,
- source="https://source.example.com/post",
+ source=f"https://source.example/{identifier}",
target="https://dennisfink.me/post",
- status="verified",
+ status=status,
)
)
db.session.commit()
+ return identifier
- with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
- send_webmention_notification.call_local(identifier)
- send.assert_called_once()
- message = send.call_args.args[0]
- assert message.recipients == ["owner@example.com"]
- assert "https://source.example.com/post" in message.body
- assert "https://dennisfink.me/post" in message.body
+def test_digest_sends_one_email_for_multiple_verified_mentions(
+ notifications: ModuleType, app: Flask
+) -> None:
+ app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
+ first = create_mention(app)
+ second = create_mention(app)
+ unverified = create_mention(app, "failed")
-@pytest.mark.parametrize("status", ["received", "verifying", "failed", "deleted"])
-def test_skips_unverified_webmentions(app: Flask, status: str) -> None:
- from webmentions_ssg.tasks.notifications import send_webmention_notification
+ with app.app_context():
+ with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
+ notifications.send_webmention_digest()
+ notifications.send_webmention_digest()
- app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
- identifier = uuid.uuid7()
+ send.assert_called_once()
+ message = send.call_args.args[0]
- with app.app_context():
- db.session.add(
- ReceivedWebmention(
- uuid=identifier,
- source="https://source.example.com/post",
- target="https://dennisfink.me/post",
- status=status,
- )
- )
- db.session.commit()
+ assert message.recipients == ["owner@example.com"]
+ assert "2 new Webmentions" in message.body
+ assert "source.example" not in message.body
- with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
- send_webmention_notification.call_local(identifier)
+ first_mention = db.session.get(ReceivedWebmention, first)
+ second_mention = db.session.get(ReceivedWebmention, second)
+ unverified_mention = db.session.get(ReceivedWebmention, unverified)
- send.assert_not_called()
+ assert first_mention is not None
+ assert second_mention is not None
+ assert unverified_mention is not None
+ assert first_mention.notification_sent_at is not None
+ assert second_mention.notification_sent_at is not None
+ assert unverified_mention.notification_sent_at is None
-def test_skips_when_notifications_disabled(app: Flask) -> None:
- from webmentions_ssg.tasks.notifications import send_webmention_notification
+def test_digest_skips_when_notifications_disabled(
+ notifications: ModuleType, app: Flask
+) -> None:
app.config["NOTIFICATION_EMAIL"] = None
- identifier = uuid.uuid7()
+ identifier = create_mention(app)
with app.app_context():
- db.session.add(
- ReceivedWebmention(
- uuid=identifier,
- source="https://source.example.com/post",
- target="https://dennisfink.me/post",
- status="verified",
- )
- )
- db.session.commit()
-
with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
- send_webmention_notification.call_local(identifier)
+ notifications.send_webmention_digest()
send.assert_not_called()
+ mention = db.session.get(ReceivedWebmention, identifier)
+ assert mention is not None
+ assert mention.notification_sent_at is None
-def test_skips_unknown_webmention(app: Flask) -> None:
- from webmentions_ssg.tasks.notifications import send_webmention_notification
+def test_digest_does_not_mark_mentions_when_email_fails(
+ notifications: ModuleType, app: Flask
+) -> None:
app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
+ identifier = create_mention(app)
with app.app_context():
- with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
- send_webmention_notification.call_local(uuid.uuid7())
+ with (
+ patch(
+ "webmentions_ssg.tasks.notifications.mail.send",
+ side_effect=RuntimeError("SMTP unavailable"),
+ ),
+ pytest.raises(RuntimeError, match="SMTP unavailable"),
+ ):
+ notifications.send_webmention_digest()
- send.assert_not_called()
+ mention = db.session.get(ReceivedWebmention, identifier)
+ assert mention is not None
+ assert mention.notification_sent_at is None
-@pytest.mark.parametrize(
- ("send_notification", "recipient", "should_enqueue"),
- [
- pytest.param(None, "owner@example.com", True, id="default-enabled"),
- pytest.param(True, "owner@example.com", True, id="explicitly-enabled"),
- pytest.param(False, "owner@example.com", False, id="explicitly-disabled"),
- pytest.param(True, None, True, id="no-recipient-configured"),
- ],
-)
-def test_queues_notification_after_verification(
- app: Flask,
- send_notification: bool | None,
- recipient: str | None,
- should_enqueue: bool,
-) -> None:
- from webmentions_ssg.tasks import receiver
+ with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
+ notifications.send_webmention_digest()
- app.config["NOTIFICATION_EMAIL"] = recipient
- identifier = uuid.uuid7()
+ send.assert_called_once()
+ mention = db.session.get(ReceivedWebmention, identifier)
- with app.app_context():
- db.session.add(
- ReceivedWebmention(
- uuid=identifier,
- source="https://source.example.com/post",
- target="https://dennisfink.me/post",
- status="received",
- )
- )
- db.session.commit()
+ assert mention is not None
+ assert mention.notification_sent_at is not None
- with (
- patch(
- "webmentions_ssg.tasks.receiver.source_mentions_target", return_value=True
- ),
- patch("webmentions_ssg.tasks.receiver.send_webmention_notification") as enqueue,
- ):
- if send_notification is None:
- # Exercise the task's default argument.
- receiver.verify_webmention.call_local(identifier)
- else:
- receiver.verify_webmention.call_local(
- identifier, send_notification=send_notification
- )
+
+def test_digest_skips_when_no_new_mentions(
+ notifications: ModuleType, app: Flask
+) -> None:
+ app.config["NOTIFICATION_EMAIL"] = "owner@example.com"
with app.app_context():
- webmention = db.session.get(ReceivedWebmention, identifier)
- assert webmention is not None
- assert webmention.status == "verified"
+ with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
+ notifications.send_webmention_digest()
- if should_enqueue:
- enqueue.assert_called_once_with(identifier)
- else:
- enqueue.assert_not_called()
+ send.assert_not_called()