diff options
| author | Dennis Fink | 2026-11-19 18:15:34 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-11-19 18:15:34 +0100 |
| commit | 8ec35babe87ff8139ec23cc10b858b7481f132db (patch) | |
| tree | b1e2b2507abba25b570a32e7274b6c0158eac653 | |
| parent | 45d3d3fde75173dfbf27e08aae8501842a9511dd (diff) | |
| download | webmentions-ssg-8ec35babe87ff8139ec23cc10b858b7481f132db.tar.gz webmentions-ssg-8ec35babe87ff8139ec23cc10b858b7481f132db.zip | |
refactor(sender)!: align sent Webmention terminology
Rename source-list forms, views, helpers, and tests around the Sent
Webmentions UI while keeping source documents as the grouping model.
BREAKING CHANGE: authenticated outgoing routes move from `/sources` to
`/sent`, with corresponding blueprint endpoint and Python module
renames.
| -rw-r--r-- | tests/forms/test_sent.py (renamed from tests/forms/test_sources.py) | 24 | ||||
| -rw-r--r-- | tests/views/test_sent.py (renamed from tests/views/test_sources.py) | 147 | ||||
| -rw-r--r-- | webmentions_ssg/forms/sent.py (renamed from webmentions_ssg/forms/sources.py) | 20 | ||||
| -rw-r--r-- | webmentions_ssg/templates/base.html | 4 | ||||
| -rw-r--r-- | webmentions_ssg/templates/dashboard.html | 2 | ||||
| -rw-r--r-- | webmentions_ssg/templates/sent.html | 14 | ||||
| -rw-r--r-- | webmentions_ssg/templates/sent_source.html | 4 | ||||
| -rw-r--r-- | webmentions_ssg/views/__init__.py | 4 | ||||
| -rw-r--r-- | webmentions_ssg/views/sent.py (renamed from webmentions_ssg/views/sources.py) | 62 |
9 files changed, 144 insertions, 137 deletions
diff --git a/tests/forms/test_sources.py b/tests/forms/test_sent.py index 082b0d3..1cdd463 100644 --- a/tests/forms/test_sources.py +++ b/tests/forms/test_sent.py @@ -2,18 +2,18 @@ # # SPDX-License-Identifier: BSD-3-Clause -"""Validation of source-list GET filters.""" +"""Validation of sent Webmentions GET filters.""" import pytest from flask import Flask from werkzeug.datastructures import MultiDict -from webmentions_ssg.forms.sources import SourceFilterForm +from webmentions_ssg.forms.sent import SentFilterForm -def test_source_filter_form_accepts_get_params(app: Flask) -> None: - with app.test_request_context("/sources"): - form = SourceFilterForm( +def test_sent_filter_form_accepts_get_params(app: Flask) -> None: + with app.test_request_context("/sent"): + form = SentFilterForm( formdata=MultiDict( { "status": "retrying", @@ -55,19 +55,19 @@ def test_source_filter_form_accepts_get_params(app: Flask) -> None: {"date_from": "2026-11-15", "date_to": "2026-11-08"}, ], ) -def test_source_filter_form_rejects_bad_get_params( +def test_sent_filter_form_rejects_bad_get_params( app: Flask, data: dict[str, str] ) -> None: - with app.test_request_context("/sources"): - form = SourceFilterForm(formdata=MultiDict(data), meta={"csrf": False}) + with app.test_request_context("/sent"): + form = SentFilterForm(formdata=MultiDict(data), meta={"csrf": False}) assert not form.validate() assert form.errors -def test_source_filter_form_defaults_and_configured_maximum(app: Flask) -> None: +def test_sent_filter_form_defaults_and_configured_maximum(app: Flask) -> None: app.config["SOURCES_MAX_PAGE_SIZE"] = 10 - with app.test_request_context("/sources"): - form = SourceFilterForm(formdata=MultiDict(), meta={"csrf": False}) + with app.test_request_context("/sent"): + form = SentFilterForm(formdata=MultiDict(), meta={"csrf": False}) assert form.validate() assert ( form.status.data, @@ -75,7 +75,7 @@ def test_source_filter_form_defaults_and_configured_maximum(app: Flask) -> None: form.order.data, form.per_page.data, ) == ("", "last_seen", "desc", 10) - form = SourceFilterForm( + form = SentFilterForm( formdata=MultiDict({"per_page": "11"}), meta={"csrf": False} ) assert not form.validate() diff --git a/tests/views/test_sources.py b/tests/views/test_sent.py index 8f5672c..9f9e65f 100644 --- a/tests/views/test_sources.py +++ b/tests/views/test_sent.py @@ -41,14 +41,14 @@ def _href(tag: Tag) -> str: @pytest.fixture -def sources_module(app: Flask) -> ModuleType: +def sent_module(app: Flask) -> ModuleType: _ = app - from webmentions_ssg.views import sources as module + from webmentions_ssg.views import sent as module return module -@pytest.mark.parametrize("path", ["/sources", f"/sources/{uuid.uuid7()}"]) +@pytest.mark.parametrize("path", ["/sent", f"/sent/{uuid.uuid7()}"]) def test_sent_views_require_login(client: FlaskClient, path: str) -> None: response = client.get(path) @@ -56,28 +56,33 @@ def test_sent_views_require_login(client: FlaskClient, path: str) -> None: assert "/login" in response.headers["Location"] -def test_sent_lists_sources(app: Flask, client: FlaskClient) -> None: +def test_sent_lists_source_documents(app: Flask, client: FlaskClient) -> None: log_in(app, client) identifier = create_sent_source(app) - response = client.get("/sources") + response = client.get("/sent") assert response.status_code == HTTPStatus.OK html = response.get_data(as_text=True) + soup = BeautifulSoup(html, "html.parser") + assert soup.h1 is not None + assert soup.h1.get_text(strip=True) == "Sent Webmentions" + assert "1 source document" in html + assert soup.select_one('form[action="/sent"]') is not None assert "blog/example/index.html" in html assert "https://dennisfink.me/blog/example/" in html - assert f"/sources/{identifier}" in html + assert f"/sent/{identifier}" in html -def test_sent_sources_table_hides_secondary_columns_on_mobile( +def test_sent_source_documents_table_hides_secondary_columns_on_mobile( app: Flask, client: FlaskClient ) -> None: log_in(app, client) create_sent_source(app) - response = client.get("/sources") + response = client.get("/sent") assert response.status_code == HTTPStatus.OK html = BeautifulSoup(response.get_data(as_text=True), "html.parser") @@ -100,7 +105,7 @@ def test_sent_source_lists_webmentions(app: Flask, client: FlaskClient) -> None: log_in(app, client) identifier = create_sent_source(app) - response = client.get(f"/sources/{identifier}") + response = client.get(f"/sent/{identifier}") assert response.status_code == HTTPStatus.OK @@ -108,6 +113,8 @@ def test_sent_source_lists_webmentions(app: Flask, client: FlaskClient) -> None: assert "blog/example/index.html" in html assert "https://dennisfink.me/blog/example/" in html + assert "Sent Webmention Source" in html + assert "Back to Sent Webmentions" in html first_target = "https://example.com/a" second_target = "https://example.com/b" @@ -126,7 +133,7 @@ def test_sent_webmentions_table_keeps_status_and_actions_on_mobile( log_in(app, client) identifier = create_sent_source(app) - response = client.get(f"/sources/{identifier}") + response = client.get(f"/sent/{identifier}") assert response.status_code == HTTPStatus.OK html = BeautifulSoup(response.get_data(as_text=True), "html.parser") @@ -149,12 +156,12 @@ def test_sent_source_returns_404_for_unknown_source( app: Flask, client: FlaskClient ) -> None: log_in(app, client) - response = client.get(f"/sources/{uuid.uuid7()}") + response = client.get(f"/sent/{uuid.uuid7()}") assert response.status_code == HTTPStatus.NOT_FOUND def test_rescan_sent_sources_requires_login(client: FlaskClient) -> None: - response = client.post("/sources/rescan") + response = client.post("/sent/rescan") assert response.status_code == HTTPStatus.FOUND assert "/login" in response.headers["Location"] @@ -164,16 +171,16 @@ def test_rescan_sent_sources_requires_login(client: FlaskClient) -> None: def test_rescan_sent_sources( app: Flask, client: FlaskClient, - sources_module: ModuleType, + sent_module: ModuleType, monkeypatch: pytest.MonkeyPatch, valid: bool, ) -> None: log_in(app, client) - form = mock_admin_action_form(sources_module, monkeypatch, valid=valid) + form = mock_admin_action_form(sent_module, monkeypatch, valid=valid) manual_scan_sources = Mock() - monkeypatch.setattr(sources_module, "manual_scan_sources", manual_scan_sources) + monkeypatch.setattr(sent_module, "manual_scan_sources", manual_scan_sources) - response = client.post("/sources/rescan") + response = client.post("/sent/rescan") assert response.status_code == ( HTTPStatus.FOUND if valid else HTTPStatus.BAD_REQUEST @@ -181,14 +188,14 @@ def test_rescan_sent_sources( form.validate_on_submit.assert_called_once_with() if valid: - assert response.headers["Location"].endswith("/sources") + assert response.headers["Location"].endswith("/sent") manual_scan_sources.assert_called_once_with() else: manual_scan_sources.assert_not_called() def test_resend_sent_webmention_requires_login(client: FlaskClient) -> None: - response = client.post(f"/sources/{uuid.uuid7()}/{uuid.uuid7()}/resend") + response = client.post(f"/sent/{uuid.uuid7()}/{uuid.uuid7()}/resend") assert response.status_code == HTTPStatus.FOUND assert "/login" in response.headers["Location"] @@ -197,15 +204,15 @@ def test_resend_sent_webmention_requires_login(client: FlaskClient) -> None: def test_resend_sent_webmention_rejects_invalid_form( app: Flask, client: FlaskClient, - sources_module: ModuleType, + sent_module: ModuleType, monkeypatch: pytest.MonkeyPatch, ) -> None: log_in(app, client) source_identifier, webmention_identifier = create_resendable_sent_webmention(app) - mock_admin_action_form(sources_module, monkeypatch, valid=False) + mock_admin_action_form(sent_module, monkeypatch, valid=False) response = client.post( - f"/sources/{source_identifier}/{webmention_identifier}/resend" + f"/sent/{source_identifier}/{webmention_identifier}/resend" ) assert response.status_code == HTTPStatus.BAD_REQUEST @@ -214,14 +221,14 @@ def test_resend_sent_webmention_rejects_invalid_form( def test_resend_sent_webmention_returns_404_for_unknown_webmention( app: Flask, client: FlaskClient, - sources_module: ModuleType, + sent_module: ModuleType, monkeypatch: pytest.MonkeyPatch, ) -> None: log_in(app, client) source_identifier = create_sent_source(app) - mock_admin_action_form(sources_module, monkeypatch, valid=True) + mock_admin_action_form(sent_module, monkeypatch, valid=True) - response = client.post(f"/sources/{source_identifier}/{uuid.uuid7()}/resend") + response = client.post(f"/sent/{source_identifier}/{uuid.uuid7()}/resend") assert response.status_code == HTTPStatus.NOT_FOUND @@ -229,16 +236,16 @@ def test_resend_sent_webmention_returns_404_for_unknown_webmention( def test_resend_sent_webmention_rejects_wrong_source( app: Flask, client: FlaskClient, - sources_module: ModuleType, + sent_module: ModuleType, monkeypatch: pytest.MonkeyPatch, ) -> None: log_in(app, client) _, webmention_identifier = create_resendable_sent_webmention(app) wrong_source_identifier = create_sent_source(app) - mock_admin_action_form(sources_module, monkeypatch, valid=True) + mock_admin_action_form(sent_module, monkeypatch, valid=True) response = client.post( - f"/sources/{wrong_source_identifier}/{webmention_identifier}/resend" + f"/sent/{wrong_source_identifier}/{webmention_identifier}/resend" ) assert response.status_code == HTTPStatus.NOT_FOUND @@ -247,14 +254,14 @@ def test_resend_sent_webmention_rejects_wrong_source( def test_resend_sent_webmention_reopens_current_revision( app: Flask, client: FlaskClient, - sources_module: ModuleType, + sent_module: ModuleType, monkeypatch: pytest.MonkeyPatch, ) -> None: log_in(app, client) source_identifier, webmention_identifier = create_resendable_sent_webmention(app) - mock_admin_action_form(sources_module, monkeypatch, valid=True) + mock_admin_action_form(sent_module, monkeypatch, valid=True) send_webmention = Mock() - monkeypatch.setattr(sources_module, "send_webmention", send_webmention) + monkeypatch.setattr(sent_module, "send_webmention", send_webmention) with app.app_context(): webmention = db.session.get(SentWebmention, webmention_identifier) @@ -264,11 +271,11 @@ def test_resend_sent_webmention_reopens_current_revision( db.session.commit() response = client.post( - f"/sources/{source_identifier}/{webmention_identifier}/resend" + f"/sent/{source_identifier}/{webmention_identifier}/resend" ) assert response.status_code == HTTPStatus.FOUND - assert response.headers["Location"].endswith(f"/sources/{source_identifier}") + assert response.headers["Location"].endswith(f"/sent/{source_identifier}") with app.app_context(): webmention = db.session.get(SentWebmention, webmention_identifier) @@ -311,7 +318,7 @@ def test_admin_only_links_safe_existing_status_urls( session["_user_id"] = str(user_id) session["_fresh"] = True - response = client.get(f"/sources/{source_identifier}") + response = client.get(f"/sent/{source_identifier}") assert response.status_code == HTTPStatus.OK html = response.get_data(as_text=True) assert (f'href="{status_url}"' in html) is safe @@ -366,7 +373,7 @@ def make_source( ("deleted", {"deleted"}), ], ) -def test_sources_filter_by_delivery_state_without_duplicate_rows( +def test_sent_filter_by_delivery_state_without_duplicate_rows( app: Flask, client: FlaskClient, status: str, expected: set[str] ) -> None: log_in(app, client) @@ -388,7 +395,7 @@ def test_sources_filter_by_delivery_state_without_duplicate_rows( make_source(app, "sent") make_source(app, "pending", statuses=(None,), processed=False) - response = client.get("/sources", query_string={"status": status}) + response = client.get("/sent", query_string={"status": status}) assert response.status_code == HTTPStatus.OK soup = BeautifulSoup(response.get_data(as_text=True), "html.parser") paths = [] @@ -414,23 +421,23 @@ def test_sources_filter_by_delivery_state_without_duplicate_rows( ("alpha%", None), ], ) -def test_sources_search_matches_path_source_url_and_sent_target( +def test_sent_search_matches_path_source_url_and_sent_target( app: Flask, client: FlaskClient, q: str, expected: str | None ) -> None: log_in(app, client) make_source(app, "alpha") make_source(app, "beta") - response = client.get("/sources", query_string={"q": f" {q} "}) + response = client.get("/sent", query_string={"q": f" {q} "}) assert response.status_code == HTTPStatus.OK html = response.get_data(as_text=True) assert ("blog/alpha/index.html" in html) == (expected == "alpha") assert "blog/beta/index.html" not in html if expected is None: - assert "No sources match these filters." in html + assert "No source documents match these filters." in html -def test_sources_filter_by_inclusive_last_seen_dates( +def test_sent_filter_by_inclusive_last_seen_dates( app: Flask, client: FlaskClient ) -> None: log_in(app, client) @@ -438,7 +445,7 @@ def test_sources_filter_by_inclusive_last_seen_dates( make_source(app, "included", last_seen_at=datetime(2026, 11, 10, 22, tzinfo=UTC)) make_source(app, "new", last_seen_at=datetime(2026, 11, 15, tzinfo=UTC)) response = client.get( - "/sources", query_string={"date_from": "2026-11-08", "date_to": "2026-11-10"} + "/sent", query_string={"date_from": "2026-11-08", "date_to": "2026-11-10"} ) assert response.status_code == HTTPStatus.OK html = response.get_data(as_text=True) @@ -450,13 +457,13 @@ def test_sources_filter_by_inclusive_last_seen_dates( @pytest.mark.parametrize( "sort", ["path", "url", "webmentions", "revision", "created", "last_seen", "status"] ) -def test_sources_sort_links_preserve_filters( +def test_sent_sort_links_preserve_filters( app: Flask, client: FlaskClient, sort: str ) -> None: log_in(app, client) make_source(app, "alpha", statuses=(SentWebmentionStatus.FAILED,)) response = client.get( - "/sources", + "/sent", query_string={ "status": "failing", "q": "alpha", @@ -473,7 +480,7 @@ def test_sources_sort_links_preserve_filters( links = [ parse_qs(urlsplit(_href(a)).query) for a in soup.select("th a[href]") - if urlsplit(_href(a)).path == "/sources" + if urlsplit(_href(a)).path == "/sent" ] assert len(links) == 7 for link in links: @@ -493,7 +500,7 @@ def test_sources_sort_links_preserve_filters( assert any(link["sort"] == [sort] and link["order"] == ["desc"] for link in links) -def test_sources_sort_orders_by_count_and_path(app: Flask, client: FlaskClient) -> None: +def test_sent_sort_orders_by_count_and_path(app: Flask, client: FlaskClient) -> None: log_in(app, client) make_source(app, "z", statuses=(SentWebmentionStatus.SENT,)) make_source( @@ -505,7 +512,7 @@ def test_sources_sort_orders_by_count_and_path(app: Flask, client: FlaskClient) ("path", "asc", "a"), ("path", "desc", "z"), ): - response = client.get("/sources", query_string={"sort": sort, "order": order}) + response = client.get("/sent", query_string={"sort": sort, "order": order}) assert response.status_code == HTTPStatus.OK soup = BeautifulSoup(response.get_data(as_text=True), "html.parser") link = soup.select_one("tbody tr td a") @@ -513,7 +520,7 @@ def test_sources_sort_orders_by_count_and_path(app: Flask, client: FlaskClient) assert link.get_text(strip=True) == f"blog/{expected_first}/index.html" -def test_sources_filter_pagination_and_navigation_preserve_parameters( +def test_sent_filter_pagination_and_navigation_preserve_parameters( app: Flask, client: FlaskClient ) -> None: log_in(app, client) @@ -526,21 +533,21 @@ def test_sources_filter_pagination_and_navigation_preserve_parameters( "order": "asc", "per_page": "10", } - response = client.get("/sources", query_string={**filters, "page": "2"}) + response = client.get("/sent", query_string={**filters, "page": "2"}) assert response.status_code == HTTPStatus.OK html = response.get_data(as_text=True) - assert "28 sources" in html + assert "28 source documents" in html soup = BeautifulSoup(html, "html.parser") assert len(soup.select("tbody tr")) == 10 urls = [_href(a) for a in soup.select("a[href]")] assert any( - urlsplit(url).path == "/sources" + urlsplit(url).path == "/sent" and parse_qs(urlsplit(url).query) == {**{k: [v] for k, v in filters.items()}, "page": ["3"]} for url in urls ) detail_urls = [ - url for url in urls if re.search(r"/sources/[0-9a-f-]{36}", urlsplit(url).path) + url for url in urls if re.search(r"/sent/[0-9a-f-]{36}", urlsplit(url).path) ] assert detail_urls assert parse_qs(urlsplit(detail_urls[0]).query) == { @@ -550,7 +557,7 @@ def test_sources_filter_pagination_and_navigation_preserve_parameters( detail = client.get(detail_urls[0]) assert detail.status_code == HTTPStatus.OK back = BeautifulSoup(detail.get_data(as_text=True), "html.parser").select_one( - 'a[href*="/sources?"]' + 'a[href*="/sent?"]' ) assert back is not None assert parse_qs(urlsplit(_href(back)).query) == { @@ -573,25 +580,25 @@ def test_sources_filter_pagination_and_navigation_preserve_parameters( "date_from=2026-11-10&date_to=2026-11-01", ], ) -def test_sources_bad_filters_return_400( +def test_sent_bad_filters_return_400( app: Flask, client: FlaskClient, invalid: str ) -> None: log_in(app, client) - assert client.get(f"/sources?{invalid}").status_code == HTTPStatus.BAD_REQUEST + assert client.get(f"/sent?{invalid}").status_code == HTTPStatus.BAD_REQUEST def test_rescan_sources_preserves_filter_query( app: Flask, client: FlaskClient, - sources_module: ModuleType, + sent_module: ModuleType, monkeypatch: pytest.MonkeyPatch, ) -> None: log_in(app, client) - mock_admin_action_form(sources_module, monkeypatch, valid=True) + mock_admin_action_form(sent_module, monkeypatch, valid=True) scan = Mock() - monkeypatch.setattr(sources_module, "manual_scan_sources", scan) + monkeypatch.setattr(sent_module, "manual_scan_sources", scan) response = client.post( - "/sources/rescan", + "/sent/rescan", query_string={"status": "retrying", "per_page": 37, "page": 2}, ) assert response.status_code == HTTPStatus.FOUND @@ -603,7 +610,7 @@ def test_rescan_sources_preserves_filter_query( scan.assert_called_once_with() -def test_sources_show_failed_and_retrying_counts_and_retry_deadline( +def test_sent_show_failed_and_retrying_counts_and_retry_deadline( app: Flask, client: FlaskClient ) -> None: log_in(app, client) @@ -614,13 +621,13 @@ def test_sources_show_failed_and_retrying_counts_and_retry_deadline( retrying=True, processed=False, ) - response = client.get("/sources", query_string={"status": "retrying"}) + response = client.get("/sent", query_string={"status": "retrying"}) assert response.status_code == HTTPStatus.OK html = response.get_data(as_text=True) assert "1 failed" in html assert "1 awaiting retry" in html - response = client.get(f"/sources/{identifier}") + response = client.get(f"/sent/{identifier}") assert response.status_code == HTTPStatus.OK assert "Retry scheduled after attempt 2:" in response.get_data(as_text=True) @@ -628,17 +635,17 @@ def test_sources_show_failed_and_retrying_counts_and_retry_deadline( def test_resend_preserves_source_filter_context( app: Flask, client: FlaskClient, - sources_module: ModuleType, + sent_module: ModuleType, monkeypatch: pytest.MonkeyPatch, ) -> None: log_in(app, client) source_id, mention_id = create_resendable_sent_webmention(app) - mock_admin_action_form(sources_module, monkeypatch, valid=True) + mock_admin_action_form(sent_module, monkeypatch, valid=True) send = Mock() - monkeypatch.setattr(sources_module, "send_webmention", send) + monkeypatch.setattr(sent_module, "send_webmention", send) response = client.post( - f"/sources/{source_id}/{mention_id}/resend", + f"/sent/{source_id}/{mention_id}/resend", query_string={ "status": "failing", "q": "resend", @@ -648,7 +655,7 @@ def test_resend_preserves_source_filter_context( }, ) assert response.status_code == HTTPStatus.FOUND - assert urlsplit(response.headers["Location"]).path == f"/sources/{source_id}" + assert urlsplit(response.headers["Location"]).path == f"/sent/{source_id}" assert parse_qs(urlsplit(response.headers["Location"]).query) == { "status": ["failing"], "q": ["resend"], @@ -659,7 +666,7 @@ def test_resend_preserves_source_filter_context( send.assert_called_once_with(mention_id) -def test_sources_show_sql_statistics_with_zero_webmentions( +def test_sent_show_sql_statistics_with_zero_webmentions( app: Flask, client: FlaskClient ) -> None: log_in(app, client) @@ -675,7 +682,7 @@ def test_sources_show_sql_statistics_with_zero_webmentions( ) make_source(app, "empty-stats", statuses=()) - response = client.get("/sources", query_string={"sort": "path", "order": "asc"}) + response = client.get("/sent", query_string={"sort": "path", "order": "asc"}) assert response.status_code == HTTPStatus.OK rows = BeautifulSoup(response.get_data(as_text=True), "html.parser").select( "tbody tr" @@ -690,12 +697,12 @@ def test_sources_show_sql_statistics_with_zero_webmentions( assert "awaiting retry" not in mixed -def test_sources_empty_filter_result_keeps_rescan_modal( +def test_sent_empty_filter_result_keeps_rescan_modal( app: Flask, client: FlaskClient ) -> None: log_in(app, client) - response = client.get("/sources", query_string={"status": "failing"}) + response = client.get("/sent", query_string={"status": "failing"}) assert response.status_code == HTTPStatus.OK html = response.get_data(as_text=True) - assert "No sources match these filters." in html + assert "No source documents match these filters." in html assert 'id="confirmation-modal"' in html diff --git a/webmentions_ssg/forms/sources.py b/webmentions_ssg/forms/sent.py index 04afe77..65a2708 100644 --- a/webmentions_ssg/forms/sources.py +++ b/webmentions_ssg/forms/sent.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: BSD-3-Clause -"""Source document filtering form.""" +"""Filters for the sent Webmentions page.""" from flask import current_app from flask_wtf import FlaskForm @@ -18,23 +18,23 @@ from wtforms.validators import AnyOf, NumberRange, Optional from .validators import CanonicalDate -SOURCE_STATUS_CHOICES = { - "": "All sources", +SENT_STATUS_CHOICES = { + "": "All source documents", "failing": "Failing sends", "retrying": "Awaiting retry", - "deleted": "Deleted sources", + "deleted": "Deleted source documents", } -def default_source_page_size() -> int: +def default_sent_page_size() -> int: """Use 25 rows unless the configured maximum is lower.""" return min(25, current_app.config["SOURCES_MAX_PAGE_SIZE"]) -class SourceFilterForm(FlaskForm): - """GET filters for the source document list.""" +class SentFilterForm(FlaskForm): + """GET filters for sent Webmentions grouped by source document.""" - status = SelectField("Status", choices=SOURCE_STATUS_CHOICES, default="") + status = SelectField("Status", choices=SENT_STATUS_CHOICES, default="") q = SearchField("Path or URL") date_from = DateField( "Last seen from (UTC)", validators=[Optional(), CanonicalDate()] @@ -59,12 +59,12 @@ class SourceFilterForm(FlaskForm): order = HiddenField(default="desc", validators=[AnyOf(("asc", "desc"))]) per_page = IntegerField( "Rows per page", - default=default_source_page_size, + default=default_sent_page_size, validators=[NumberRange(min=1)], ) def validate_per_page(self, field: IntegerField) -> None: - """Enforce the deployment's maximum source-list page size.""" + """Enforce the deployment's maximum source-document page size.""" if ( field.data is not None and field.data > current_app.config["SOURCES_MAX_PAGE_SIZE"] diff --git a/webmentions_ssg/templates/base.html b/webmentions_ssg/templates/base.html index 17c06d2..e21c663 100644 --- a/webmentions_ssg/templates/base.html +++ b/webmentions_ssg/templates/base.html @@ -49,8 +49,8 @@ SPDX-License-Identifier: BSD-3-Clause href='{{ url_for("webmentions.received_list") }}'>Received</a> <a class="nav-link{% if request.endpoint and request.endpoint.startswith('webmentions.moderation') %} active{% endif %}" href="{{ url_for('webmentions.moderation') }}">Moderation</a> - <a class="nav-link{% if request.endpoint == 'webmentions.source_list' %} active{% endif %}" - href='{{ url_for("webmentions.source_list") }}'>Sent</a> + <a class="nav-link{% if request.endpoint in ('webmentions.sent_list', 'webmentions.sent_source_detail') %} active{% endif %}" + href='{{ url_for("webmentions.sent_list") }}'>Sent</a> <a class="nav-link{% if request.endpoint == 'webmentions.user_page' %} active{% endif %}" href="{{ url_for('webmentions.user_page') }}">User</a> <form action="{{ url_for('webmentions.logout') }}" diff --git a/webmentions_ssg/templates/dashboard.html b/webmentions_ssg/templates/dashboard.html index b020d46..4fa1e90 100644 --- a/webmentions_ssg/templates/dashboard.html +++ b/webmentions_ssg/templates/dashboard.html @@ -46,7 +46,7 @@ SPDX-License-Identifier: BSD-3-Clause <div class="card-body"> <div class="d-flex justify-content-between align-items-center mb-3"> <h2 class="h4 mb-0" id="sent-summary">Outgoing</h2> - <a href="{{ url_for('webmentions.source_list') }}">View sources</a> + <a href="{{ url_for('webmentions.sent_list') }}">View sent Webmentions</a> </div> <p class="display-6 mb-3">{{ sent_total }} <span class="fs-6 text-body-secondary">total</span></p> <div class="row row-cols-2 g-3"> diff --git a/webmentions_ssg/templates/sent.html b/webmentions_ssg/templates/sent.html index 46296b8..9db0156 100644 --- a/webmentions_ssg/templates/sent.html +++ b/webmentions_ssg/templates/sent.html @@ -22,9 +22,9 @@ SPDX-License-Identifier: BSD-3-Clause {% block content %} <div class="d-flex justify-content-between align-items-center mb-3"> - <h1 class="mb-0">Sources</h1> + <h1 class="mb-0">Sent Webmentions</h1> <div class="d-flex flex-column justify-content-between"> - <span class="text-body-secondary mb-1">{{ sources.total }} sources</span> + <span class="text-body-secondary mb-1">{{ sources.total }} source document{{ "s" if sources.total != 1 else "" }}</span> <button type="button" class="btn btn-sm btn-primary" data-bs-toggle="modal" @@ -36,7 +36,7 @@ SPDX-License-Identifier: BSD-3-Clause data-confirm-class="btn-primary">Rescan</button> </div> </div> - <form action="{{ url_for('webmentions.source_list') }}" + <form action="{{ url_for('webmentions.sent_list') }}" method="get" class="row g-2 align-items-end mb-4" role="search"> @@ -64,7 +64,7 @@ SPDX-License-Identifier: BSD-3-Clause </div> <div class="col-auto d-flex gap-2 ms-auto"> <button type="submit" class="btn btn-primary">Filter</button> - <a href="{{ url_for('webmentions.source_list') }}" + <a href="{{ url_for('webmentions.sent_list') }}" class="btn btn-outline-secondary">Clear</a> </div> </form> @@ -99,7 +99,7 @@ SPDX-License-Identifier: BSD-3-Clause <span class="badge {{ badge_class }}">{{ status_text }}</span> </td> <td class="text-break"> - <a href="{{ url_for('webmentions.source_detail', source_uuid=source.uuid, source_page=sources.page, **filters) }}">{{ source.path }}</a> + <a href="{{ url_for('webmentions.sent_source_detail', source_uuid=source.uuid, source_page=sources.page, **filters) }}">{{ source.path }}</a> </td> <td class="text-break d-none d-md-table-cell"> <a href="{{ source.url }}">{{ source.url }}</a> @@ -142,9 +142,9 @@ SPDX-License-Identifier: BSD-3-Clause {% endif %} {% else %} {% if filters %} - <p class="text-body-secondary">No sources match these filters.</p> + <p class="text-body-secondary">No source documents match these filters.</p> {% else %} - <p class="text-body-secondary">No Webmention sources have been discovered yet.</p> + <p class="text-body-secondary">No source documents with outgoing Webmentions have been discovered yet.</p> {% endif %} {% endif %} {% include "includes/confirmation_modal.html" %} diff --git a/webmentions_ssg/templates/sent_source.html b/webmentions_ssg/templates/sent_source.html index 04f9d07..a24bde3 100644 --- a/webmentions_ssg/templates/sent_source.html +++ b/webmentions_ssg/templates/sent_source.html @@ -26,10 +26,10 @@ SPDX-License-Identifier: BSD-3-Clause {% block content %} <div class="mb-3"> - <a href="{{ url_for('webmentions.source_list', page=source_page, **filters) }}">← Back to sources</a> + <a href="{{ url_for('webmentions.sent_list', page=source_page, **filters) }}">← Back to Sent Webmentions</a> </div> <div class="d-flex justify-content-between align-items-start mb-3"> - <h1 class="mb-0">Source Details</h1> + <h1 class="mb-0">Sent Webmention Source</h1> </div> <div class="d-flex justify-content-between align-items-start mb-3"> <dl class="row"> diff --git a/webmentions_ssg/views/__init__.py b/webmentions_ssg/views/__init__.py index 5abaa14..1701838 100644 --- a/webmentions_ssg/views/__init__.py +++ b/webmentions_ssg/views/__init__.py @@ -4,7 +4,7 @@ """Collect and expose the routes for the blueprint.""" -from . import dashboard, endpoint, moderation, received, session, sources, user +from . import dashboard, endpoint, moderation, received, session, sent, user from .blueprint import webmentions_bp __all__ = [ @@ -13,7 +13,7 @@ __all__ = [ "moderation", "received", "session", - "sources", + "sent", "user", "webmentions_bp", ] diff --git a/webmentions_ssg/views/sources.py b/webmentions_ssg/views/sent.py index 22cabb6..27dffb3 100644 --- a/webmentions_ssg/views/sources.py +++ b/webmentions_ssg/views/sent.py @@ -2,7 +2,7 @@ # # SPDX-License-Identifier: BSD-3-Clause -"""Authenticated source document and sent Webmention views.""" +"""Authenticated sent Webmention views, grouped by source document.""" import uuid from datetime import UTC, date, datetime, time @@ -16,10 +16,10 @@ from flask_login import login_required from ..extensions import db from ..forms.admin import ConfirmActionForm -from ..forms.sources import ( - SOURCE_STATUS_CHOICES, - SourceFilterForm, - default_source_page_size, +from ..forms.sent import ( + SENT_STATUS_CHOICES, + SentFilterForm, + default_sent_page_size, ) from ..models.sources import SentWebmention, SentWebmentionStatus, SourceDocument from ..tasks.scanner import manual_scan_sources @@ -27,8 +27,8 @@ from ..tasks.sender import send_webmention from .blueprint import webmentions_bp -class SourceFilterArgs(TypedDict, total=False): - """Validated source-list query parameters; keys match GET form fields.""" +class SentFilterArgs(TypedDict, total=False): + """Validated sent-page query parameters; keys match GET form fields.""" status: str q: str @@ -39,34 +39,34 @@ class SourceFilterArgs(TypedDict, total=False): per_page: str -def source_filter_form() -> SourceFilterForm: +def sent_filter_form() -> SentFilterForm: """Validate GET filters without requiring CSRF on the search form.""" - form = SourceFilterForm(formdata=request.args, meta={"csrf": False}) + form = SentFilterForm(formdata=request.args, meta={"csrf": False}) if not form.validate(): abort(HTTPStatus.BAD_REQUEST) form.q.data = (form.q.data or "").strip() return form -def source_filter_args(form: SourceFilterForm) -> SourceFilterArgs: +def sent_filter_args(form: SentFilterForm) -> SentFilterArgs: """Serialize non-default values for pagination, sorting, and navigation.""" values: dict[str, str] = {} - for name in SourceFilterArgs.__annotations__: + for name in SentFilterArgs.__annotations__: field = form[name] value = field.data default = field.default() if callable(field.default) else field.default if value is None or value == "" or value == default: continue values[name] = value.isoformat() if isinstance(value, date) else str(value) - return cast(SourceFilterArgs, values) + return cast(SentFilterArgs, values) -@webmentions_bp.route("/sources") +@webmentions_bp.route("/sent") @login_required -def source_list() -> ResponseReturnValue: - """Display source documents with filters for outgoing delivery problems.""" - filter_form = source_filter_form() - filters = source_filter_args(filter_form) +def sent_list() -> ResponseReturnValue: + """Display sent Webmentions grouped by source document.""" + filter_form = sent_filter_form() + filters = sent_filter_args(filter_form) query = sa.select(SourceDocument) # EXISTS avoids duplicate source rows when several Webmentions match. @@ -134,7 +134,7 @@ def source_list() -> ResponseReturnValue: if sort_key != "created": query = query.order_by(SourceDocument.uuid.desc()) - page_size = int(filters.get("per_page", default_source_page_size())) + page_size = int(filters.get("per_page", default_sent_page_size())) sources = db.paginate( query, per_page=page_size, @@ -158,8 +158,8 @@ def source_list() -> ResponseReturnValue: next_order = "asc" if sort_order == "desc" else "desc" else: next_order = "asc" if key in ("path", "url", "status") else "desc" - sort_filters: SourceFilterArgs = {**filters, "sort": key, "order": next_order} - sort_urls[key] = url_for("webmentions.source_list", **sort_filters) + sort_filters: SentFilterArgs = {**filters, "sort": key, "order": next_order} + sort_urls[key] = url_for("webmentions.sent_list", **sort_filters) return render_template( "sent.html", @@ -170,7 +170,7 @@ def source_list() -> ResponseReturnValue: sort_key=sort_key, sort_order=sort_order, sort_urls=sort_urls, - status_choices=SOURCE_STATUS_CHOICES, + status_choices=SENT_STATUS_CHOICES, page_size=page_size, max_source_page_size=current_app.config["SOURCES_MAX_PAGE_SIZE"], filter_form=filter_form, @@ -178,7 +178,7 @@ def source_list() -> ResponseReturnValue: ) -@webmentions_bp.post("/sources/rescan") +@webmentions_bp.post("/sent/rescan") @login_required def rescan_sources() -> ResponseReturnValue: """Queue a manual scan of sent Webmention sources. @@ -188,25 +188,25 @@ def rescan_sources() -> ResponseReturnValue: if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) - filters = source_filter_args(source_filter_form()) + filters = sent_filter_args(sent_filter_form()) manual_scan_sources() flash("Source rescan queued.", "success") page = request.args.get("page", 1, type=int) return redirect( - url_for("webmentions.source_list", page=page if page > 1 else None, **filters) + url_for("webmentions.sent_list", page=page if page > 1 else None, **filters) ) -@webmentions_bp.route("/sources/<uuid:source_uuid>") +@webmentions_bp.route("/sent/<uuid:source_uuid>") @login_required -def source_detail(source_uuid: uuid.UUID) -> ResponseReturnValue: +def sent_source_detail(source_uuid: uuid.UUID) -> ResponseReturnValue: """Display the sent Webmentions associated with a source. :param source_uuid: UUID of the source to display. :returns: Rendered source details page. """ - filters = source_filter_args(source_filter_form()) + filters = sent_filter_args(sent_filter_form()) source_page = request.args.get("source_page", 1, type=int) source = db.get_or_404(SourceDocument, source_uuid) @@ -219,7 +219,7 @@ def source_detail(source_uuid: uuid.UUID) -> ResponseReturnValue: return render_template( "sent_source.html", - title="Sent Webmentions", + title="Sent Webmention Source", source=source, webmentions=webmentions, filters=filters, @@ -228,7 +228,7 @@ def source_detail(source_uuid: uuid.UUID) -> ResponseReturnValue: ) -@webmentions_bp.post("/sources/<uuid:source_uuid>/<uuid:webmention_uuid>/resend") +@webmentions_bp.post("/sent/<uuid:source_uuid>/<uuid:webmention_uuid>/resend") @login_required def resend_webmention( source_uuid: uuid.UUID, webmention_uuid: uuid.UUID @@ -247,7 +247,7 @@ def resend_webmention( if not ConfirmActionForm().validate_on_submit(): abort(HTTPStatus.BAD_REQUEST) - filters = source_filter_args(source_filter_form()) + filters = sent_filter_args(sent_filter_form()) webmention = db.get_or_404(SentWebmention, webmention_uuid) if webmention.source_uuid != source_uuid: @@ -268,7 +268,7 @@ def resend_webmention( source_page = request.args.get("source_page", 1, type=int) return redirect( url_for( - "webmentions.source_detail", + "webmentions.sent_source_detail", source_uuid=source_uuid, page=page if page > 1 else None, source_page=source_page if source_page > 1 else None, |
