From 354a5b449077478b141683bafbab47c9dc169d21 Mon Sep 17 00:00:00 2001 From: Dennis Fink Date: Mon, 16 Nov 2026 22:21:19 +0100 Subject: feat(receiver): add sorting and page size controls Allow received Webmentions to be sorted by status, source, target, received time, or updated time with stable pagination and accessible sortable headers. Add configurable per-page sizing and preserve sorting, filters, and page size across pagination and administrative actions. --- tests/test_config.py | 21 +++- tests/test_forms.py | 44 ++++++- tests/views/test_admin.py | 309 +++++++++++++++++++++++++++++++++++++++++++++- 3 files changed, 370 insertions(+), 4 deletions(-) (limited to 'tests') diff --git a/tests/test_config.py b/tests/test_config.py index a4c5e9b..d075e7d 100644 --- a/tests/test_config.py +++ b/tests/test_config.py @@ -354,11 +354,18 @@ def test_resource_limits_have_safe_defaults() -> None: assert DefaultConfig.MAX_CONTENT_LENGTH == 64 * 1024 assert DefaultConfig.MAX_WEBMENTION_URL_BYTES == 8192 assert DefaultConfig.RECEIVED_RETENTION_DAYS == 30 + assert DefaultConfig.RECEIVED_MAX_PAGE_SIZE == 100 assert DefaultConfig.RECEIVED_RETENTION_SCHEDULE == "0 3 * * *" @pytest.mark.parametrize( - "key", ["MAX_CONTENT_LENGTH", "MAX_WEBMENTION_URL_BYTES", "RECEIVED_RETENTION_DAYS"] + "key", + [ + "MAX_CONTENT_LENGTH", + "MAX_WEBMENTION_URL_BYTES", + "RECEIVED_RETENTION_DAYS", + "RECEIVED_MAX_PAGE_SIZE", + ], ) @pytest.mark.parametrize("value", [None, "100", 0, -1, 1.5]) def test_invalid_resource_limits_fail_at_startup( @@ -372,6 +379,18 @@ def test_invalid_resource_limits_fail_at_startup( create_app(InvalidResourceLimit) +def test_received_max_page_size_can_be_set_in_cfg(tmp_path: Path) -> None: + config_file = tmp_path / "development.cfg" + config_file.write_text("RECEIVED_MAX_PAGE_SIZE = 250\n") + + class ConfiguredDevelopment(DevelopmentConfig): + CONFIG_FILE = str(config_file) + LOG_FILE = str(tmp_path / "development.log") + + app = create_app(ConfiguredDevelopment) + assert app.config["RECEIVED_MAX_PAGE_SIZE"] == 250 + + def test_proxy_fix_disabled_by_default(tmp_path: Path) -> None: class DirectConfig(TestingConfig): LOG_FILE = str(tmp_path / "direct.log") diff --git a/tests/test_forms.py b/tests/test_forms.py index 7f09da6..c6a8b25 100644 --- a/tests/test_forms.py +++ b/tests/test_forms.py @@ -12,8 +12,8 @@ from webmentions_ssg.forms import ( ConfirmActionForm, LoginForm, MaxURLBytes, - RejectNonPublicIPLiteral, ReceivedWebmentionFilterForm, + RejectNonPublicIPLiteral, WebmentionSubmissionForm, ) @@ -186,6 +186,48 @@ def test_received_filter_form_rejects_invalid_get_params( assert form.errors +def test_received_filter_form_validates_sort_and_page_size(app: Flask) -> None: + with app.test_request_context("/received", method="GET"): + form = ReceivedWebmentionFilterForm( + formdata=MultiDict({"sort": "updated", "order": "asc", "per_page": "37"}), + meta={"csrf": False}, + ) + assert form.validate() + assert form.sort.data == "updated" + assert form.order.data == "asc" + assert form.per_page.data == 37 + + with app.test_request_context("/received", method="GET"): + form = ReceivedWebmentionFilterForm(formdata=MultiDict(), meta={"csrf": False}) + assert form.validate() + assert (form.sort.data, form.order.data, form.per_page.data) == ( + "received", + "desc", + 25, + ) + + +@pytest.mark.parametrize( + "data", + [ + {"sort": "invalid"}, + {"order": "invalid"}, + {"per_page": "0"}, + {"per_page": "101"}, + {"per_page": "invalid"}, + ], +) +def test_received_filter_form_rejects_invalid_sort_and_page_size( + app: Flask, data: dict[str, str] +) -> None: + with app.test_request_context("/received", method="GET"): + form = ReceivedWebmentionFilterForm( + formdata=MultiDict(data), meta={"csrf": False} + ) + assert not form.validate() + assert form.errors + + def test_admin_action_form_accepts_submission(app: Flask) -> None: with app.test_request_context(method="POST"): form = ConfirmActionForm(meta={"csrf": False}) diff --git a/tests/views/test_admin.py b/tests/views/test_admin.py index 73265bd..e82d94d 100644 --- a/tests/views/test_admin.py +++ b/tests/views/test_admin.py @@ -144,7 +144,209 @@ def test_received_filters_by_display_status( ) -def test_received_get_filter_form_renders_wtforms_fields( +def test_received_filter_args_uses_typed_dict_fields( + app: Flask, views_module: ModuleType +) -> None: + with app.test_request_context( + "/received", + query_string={ + "status": "declined", + "q": " example.org ", + "date_from": "2026-11-08", + "date_to": "2026-11-14", + "sort": "updated", + "order": "asc", + "per_page": "37", + }, + ): + form = views_module.received_filter_form() + assert set(views_module.ReceivedFilterArgs.__annotations__) == set(form._fields) + assert views_module.received_filter_args(form) == { + "status": "declined", + "q": "example.org", + "date_from": "2026-11-08", + "date_to": "2026-11-14", + "sort": "updated", + "order": "asc", + "per_page": "37", + } + + +@pytest.mark.parametrize("max_page_size", [10, 100]) +def test_received_filter_args_omits_defaults_for_configured_page_size( + app: Flask, views_module: ModuleType, max_page_size: int +) -> None: + app.config["RECEIVED_MAX_PAGE_SIZE"] = max_page_size + with app.test_request_context("/received"): + form = views_module.received_filter_form() + assert form.per_page.data == min(25, max_page_size) + assert views_module.received_filter_args(form) == {} + + +@pytest.mark.parametrize( + ("sort", "order", "expected"), + [ + ("received", "desc", ("removed", "failed", "verified", "pending")), + ("received", "asc", ("pending", "verified", "failed", "removed")), + ("updated", "desc", ("verified", "failed", "pending", "removed")), + ("updated", "asc", ("removed", "pending", "failed", "verified")), + ("status", "asc", ("pending", "verified", "removed", "failed")), + ("status", "desc", ("removed", "failed", "verified", "pending")), + ], +) +def test_received_sorting( + app: Flask, client: FlaskClient, sort: str, order: str, expected: tuple[str, ...] +) -> None: + log_in(app, client) + for label, status, day in ( + ("pending", "received", 12), + ("verified", "verified", 14), + ("failed", "failed", 13), + ("removed", "source_removed", 11), + ): + create_received_webmention( + app, + source=f"https://{label}.example/post", + status=status, + updated_at=datetime(2026, 11, day, tzinfo=UTC), + ) + + response = client.get("/received", query_string={"sort": sort, "order": order}) + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + indices = [html.index(f"https://{label}.example/post") for label in expected] + assert indices == sorted(indices) + assert f'aria-sort="{"ascending" if order == "asc" else "descending"}"' in html + + +@pytest.mark.parametrize("column", ["source", "target"]) +@pytest.mark.parametrize("order", ["asc", "desc"]) +def test_received_sorts_by_source_or_target( + app: Flask, client: FlaskClient, column: str, order: str +) -> None: + log_in(app, client) + # Deliberately create rows out of lexical order for both URL columns. + for source_name, target_name in ( + ("beta", "alpha"), + ("alpha", "gamma"), + ("gamma", "beta"), + ): + create_received_webmention( + app, + source=f"https://source.example/{source_name}", + target=f"https://target.example/{target_name}", + ) + + response = client.get("/received", query_string={"sort": column, "order": order}) + + assert response.status_code == HTTPStatus.OK + html = response.get_data(as_text=True) + rows = re.findall(r"