aboutsummaryrefslogtreecommitdiff
path: root/tests/tasks/test_notifications.py
blob: ca89a7ad44cd87cae95ec2059a9d223cea7f0df9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me>
#
# SPDX-License-Identifier: BSD-3-Clause


import uuid
from types import ModuleType
from unittest.mock import patch

import pytest
from flask import Flask
from huey.exceptions import TaskLockedException

from webmentions_ssg import db
from webmentions_ssg.extensions import huey
from webmentions_ssg.models import ReceivedWebmention


@pytest.fixture
def notifications(app: Flask) -> ModuleType:
    from webmentions_ssg.tasks import notifications

    return notifications


def create_mention(app: Flask, status: str = "verified") -> uuid.UUID:
    identifier = uuid.uuid7()
    with app.app_context():
        db.session.add(
            ReceivedWebmention(
                uuid=identifier,
                source=f"https://source.example/{identifier}",
                target="https://dennisfink.me/post",
                status=status,
            )
        )
        db.session.commit()
    return identifier


def test_digest_sends_one_email_for_multiple_verified_mentions(
    notifications: ModuleType, app: Flask
) -> None:
    app.config["DIGEST_EMAIL"] = "owner@example.com"

    first = create_mention(app)
    second = create_mention(app)
    unverified = create_mention(app, "failed")

    with app.app_context():
        with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
            notifications.email_verified_digest()
            notifications.email_verified_digest()

        send.assert_called_once()
        message = send.call_args.args[0]

        assert message.recipients == ["owner@example.com"]
        assert "2 new Webmentions" in message.body
        assert "source.example" not in message.body

        first_mention = db.session.get(ReceivedWebmention, first)
        second_mention = db.session.get(ReceivedWebmention, second)
        unverified_mention = db.session.get(ReceivedWebmention, unverified)

        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_digest_skips_when_notifications_disabled(
    notifications: ModuleType, app: Flask
) -> None:
    app.config["DIGEST_EMAIL"] = None
    identifier = create_mention(app)

    with app.app_context():
        with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
            notifications.email_verified_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_digest_does_not_mark_mentions_when_email_fails(
    notifications: ModuleType, app: Flask
) -> None:
    app.config["DIGEST_EMAIL"] = "owner@example.com"
    identifier = create_mention(app)

    with app.app_context():
        with (
            patch(
                "webmentions_ssg.tasks.notifications.mail.send",
                side_effect=RuntimeError("SMTP unavailable"),
            ),
            pytest.raises(RuntimeError, match="SMTP unavailable"),
        ):
            notifications.email_verified_digest()

        mention = db.session.get(ReceivedWebmention, identifier)

        assert mention is not None
        assert mention.notification_sent_at is None

        with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
            notifications.email_verified_digest()

        send.assert_called_once()
        mention = db.session.get(ReceivedWebmention, identifier)

        assert mention is not None
        assert mention.notification_sent_at is not None


def test_digest_skips_when_no_new_mentions(
    notifications: ModuleType, app: Flask
) -> None:
    app.config["DIGEST_EMAIL"] = "owner@example.com"

    with app.app_context():
        with patch("webmentions_ssg.tasks.notifications.mail.send") as send:
            notifications.email_verified_digest()

        send.assert_not_called()


def test_digest_lock_uses_current_backend(
    notifications: ModuleType, app: Flask
) -> None:
    """Verify that a previously imported digest uses the new backend lock.

    :param notifications: Digest notification module under test.
    :param app: Configured Flask application fixture.
    """
    with app.app_context():
        previous_backend = huey.huey
        huey.init_app(app)
        assert huey.huey is not previous_backend

        with (
            huey.lock_task("send-webmention-digest"),
            pytest.raises(TaskLockedException),
        ):
            notifications.email_verified_digest()