diff options
| author | Dennis Fink | 2026-11-18 08:01:26 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-11-18 08:01:26 +0100 |
| commit | b908ee61770dc78f8d8fbbbfc4f3c00d7877d42a (patch) | |
| tree | 322d85654e5518c2836ce57beafaa7e2abaab741 /tests/views/test_dashboard.py | |
| parent | 63af533d98aac82b6d4f069b217d3e837285508d (diff) | |
| download | webmentions-ssg-b908ee61770dc78f8d8fbbbfc4f3c00d7877d42a.tar.gz webmentions-ssg-b908ee61770dc78f8d8fbbbfc4f3c00d7877d42a.zip | |
feat(core): add dashboard overview
Replace the root redirect with an authenticated dashboard showing
received and outgoing status counts, recent activity, pending sends,
retries, and queue depth.
Persist the last completed source scan so operational status survives
restarts and only advances after a successful, conclusive scan.
Diffstat (limited to '')
| -rw-r--r-- | tests/views/test_dashboard.py | 202 |
1 files changed, 202 insertions, 0 deletions
diff --git a/tests/views/test_dashboard.py b/tests/views/test_dashboard.py new file mode 100644 index 0000000..05730dd --- /dev/null +++ b/tests/views/test_dashboard.py @@ -0,0 +1,202 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me> +# +# SPDX-License-Identifier: BSD-3-Clause + +from datetime import UTC, datetime, timedelta +from http import HTTPStatus +from uuid import UUID + +import pytest +from bs4 import BeautifulSoup +from flask import Flask +from flask.testing import FlaskClient + +from webmentions_ssg import db +from webmentions_ssg.models.received import ReceivedWebmention, ReceivedWebmentionStatus +from webmentions_ssg.models.scan_state import ScanState +from webmentions_ssg.models.sources import ( + SentWebmention, + SentWebmentionStatus, + SourceDocument, +) +from webmentions_ssg.views import dashboard + +from .helpers import log_in + + +def received_uuid(at: datetime, sequence: int) -> UUID: + """Construct a UUIDv7 at a controlled creation time for activity tests.""" + return UUID( + int=(int(at.timestamp() * 1000) << 80) | (7 << 76) | (2 << 62) | sequence + ) + + +def test_dashboard_is_private_and_empty_by_default( + app: Flask, client: FlaskClient +) -> None: + response = client.get("/") + assert response.status_code == HTTPStatus.FOUND + assert response.headers["Location"].startswith("/login?") + + log_in(app, client) + response = client.get("/") + assert response.status_code == HTTPStatus.OK + soup = BeautifulSoup(response.get_data(as_text=True), "html.parser") + received = soup.find("section", attrs={"aria-labelledby": "received-summary"}) + outgoing = soup.find("section", attrs={"aria-labelledby": "sent-summary"}) + assert received is not None + assert outgoing is not None + assert "0 total" in received.get_text(" ", strip=True) + assert "0 total" in outgoing.get_text(" ", strip=True) + assert "No completed scan yet" in response.get_data(as_text=True) + assert "Huey pending tasks" in response.get_data(as_text=True) + assert 'href="/received?status=declined"' in response.get_data(as_text=True) + assert 'href="/"' in response.get_data(as_text=True) + + +def test_dashboard_counts_statuses_windows_retries_and_queue( + app: Flask, client: FlaskClient, monkeypatch: pytest.MonkeyPatch +) -> None: + log_in(app, client) + now = datetime.now(UTC) + with app.app_context(): + for sequence, (status, days) in enumerate( + ( + (ReceivedWebmentionStatus.RECEIVED, 1), + (ReceivedWebmentionStatus.VERIFYING, 8), + (ReceivedWebmentionStatus.VERIFIED, 31), + (ReceivedWebmentionStatus.FAILED, 2), + (ReceivedWebmentionStatus.SOURCE_REMOVED, 3), + ), + start=1, + ): + db.session.add( + ReceivedWebmention( + uuid=received_uuid(now - timedelta(days=days), sequence), + source=f"https://source.example/{sequence}", + target="https://site.example/post", + status=status, + # Old updates must not change creation-based activity counts. + updated_at=now, + ) + ) + source = SourceDocument( + path="post/index.html", + url="https://site.example/post", + content_hash="0" * 32, + revision=2, + last_seen_at=now, + revised_at=now, + ) + source.sent_webmentions.extend( + [ + SentWebmention( + target="https://target.example/success", + desired_revision=2, + processed_revision=2, + status=SentWebmentionStatus.SENT, + last_sent_at=now - timedelta(days=3), + ), + SentWebmention( + target="https://target.example/unsupported", + desired_revision=2, + processed_revision=2, + status=SentWebmentionStatus.NO_ENDPOINT, + ), + SentWebmention( + target="https://target.example/failed", + desired_revision=2, + processed_revision=2, + status=SentWebmentionStatus.FAILED, + ), + SentWebmention( + target="https://target.example/retry", + desired_revision=2, + status=SentWebmentionStatus.FAILED, + attempt_count=1, + next_retry_at=now + timedelta(hours=1), + ), + SentWebmention( + target="https://target.example/pending", desired_revision=2 + ), + SentWebmention( + target="https://target.example/not-attempted", + desired_revision=2, + processed_revision=2, + linked=False, + ), + # A claimed in-flight send has a future deadline but no + # recorded failure and must not count as waiting to retry. + SentWebmention( + target="https://target.example/inflight", + desired_revision=2, + next_retry_at=now + timedelta(hours=1), + ), + ] + ) + db.session.add(source) + db.session.add(ScanState(id=1, last_completed_at=now)) + db.session.commit() + + monkeypatch.setattr(dashboard.huey.huey, "pending_count", lambda: 4) + response = client.get("/") + assert response.status_code == HTTPStatus.OK + soup = BeautifulSoup(response.get_data(as_text=True), "html.parser") + + received = soup.find("section", attrs={"aria-labelledby": "received-summary"}) + outgoing = soup.find("section", attrs={"aria-labelledby": "sent-summary"}) + assert received is not None + assert outgoing is not None + received_text = received.get_text(" ", strip=True) + outgoing_text = outgoing.get_text(" ", strip=True) + assert "5 total" in received_text + assert "Pending 1" in received_text + assert "Verifying 1" in received_text + assert "Verified 1" in received_text + assert "Declined 2" in received_text + assert "Failed: 1 ยท Source removed: 1" in received_text + assert "7 total" in outgoing_text + assert "Sent 1" in outgoing_text + assert "No endpoint 1" in outgoing_text + assert "Failed (final) 1" in outgoing_text + assert "Not attempted 1" in outgoing_text + assert "Pending 3" in outgoing_text + assert "Waiting to retry: 1" in outgoing_text + + recent = soup.find("section", attrs={"aria-labelledby": "recent-activity"}) + assert recent is not None + rows = recent.find_all("tr") + received_cells = rows[1].find_all(["td", "th"]) + assert [cell.get_text(" ", strip=True) for cell in received_cells] == [ + "New received Webmentions", + "3", + "4", + ] + sent_cells = rows[2].find_all(["td", "th"]) + assert [cell.get_text(" ", strip=True) for cell in sent_cells] == [ + "Webmentions last sent successfully", + "1", + "1", + ] + operations = soup.find("section", attrs={"aria-labelledby": "operations"}) + assert operations is not None + assert "Source documents 1" in operations.get_text(" ", strip=True) + assert "Huey pending tasks 4" in operations.get_text(" ", strip=True) + assert "Last completed source scan" in operations.get_text(" ", strip=True) + assert operations.find("time") is not None + + +def test_dashboard_handles_unavailable_queue( + app: Flask, client: FlaskClient, monkeypatch: pytest.MonkeyPatch +) -> None: + log_in(app, client) + + def unavailable() -> int: + raise RuntimeError("backend unavailable") + + monkeypatch.setattr(dashboard.huey.huey, "pending_count", unavailable) + response = client.get("/") + + assert response.status_code == HTTPStatus.OK + assert "Huey pending tasks" in response.get_data(as_text=True) + assert "Unavailable" in response.get_data(as_text=True) |
