diff options
| author | Dennis Fink | 2026-11-15 21:18:19 +0100 |
|---|---|---|
| committer | Dennis Fink | 2026-11-15 21:18:19 +0100 |
| commit | 9b00526ab79257b65cedd71595848f09ecf84279 (patch) | |
| tree | f9dfc5c0934499d47499bf083bd864f72947958c /webmentions_ssg/tasks/verification.py | |
| parent | 509d93b2976e353d29441a7a7b7e78ca466dc4fd (diff) | |
| download | webmentions-ssg-9b00526ab79257b65cedd71595848f09ecf84279.tar.gz webmentions-ssg-9b00526ab79257b65cedd71595848f09ecf84279.zip | |
refactor(core)!: clarify Webmention domain terminology
Rename ambiguous models, statuses, task modules, fields, and helpers so
names reflect source documents, verification, endpoint discovery, and
delivery state.
Migrate persisted status values and database identifiers without losing
existing Webmention data.
BREAKING CHANGE: persisted status values and database schema names have
changed, and several public Python names have been renamed.
Diffstat (limited to 'webmentions_ssg/tasks/verification.py')
| -rw-r--r-- | webmentions_ssg/tasks/verification.py | 363 |
1 files changed, 363 insertions, 0 deletions
diff --git a/webmentions_ssg/tasks/verification.py b/webmentions_ssg/tasks/verification.py new file mode 100644 index 0000000..a614815 --- /dev/null +++ b/webmentions_ssg/tasks/verification.py @@ -0,0 +1,363 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me> +# +# SPDX-License-Identifier: BSD-3-Clause + +"""Fetch and verify incoming Webmentions with transactional state changes.""" + +import uuid +from dataclasses import dataclass +from datetime import UTC, datetime, timedelta +from http import HTTPStatus + +import httpx +import sqlalchemy as sa +from flask import current_app + +from ..db_helpers import rows_affected +from ..extensions import db, huey +from ..models import ReceivedWebmention, ReceivedWebmentionStatus +from ..net import ( + AddressResolutionError, + ResponseTooLargeError, + UnsafeAddressError, + build_public_http_client, + is_retryable_status, + media_type_of, + read_limited_body, +) +from ..version import APP_NAME, VERSION +from .target_matching import html_mentions_target, text_mentions_target + + +class VerificationError(Exception): + """The source permanently failed ReceivedWebmention verification.""" + + +class SourceGoneError(VerificationError): + """The source explicitly reports that it has been removed.""" + + +class RetryableFetchError(Exception): + """Fetching the source may succeed when retried later.""" + + +RECOVERY_EXHAUSTED_REASON = "Verification recovery limit reached" + + +def fetch_source_document(source_url: str) -> tuple[httpx.Response, bytes]: + """Fetch a webmention source document. + + The request follows redirects while enforcing the configured timeout, + redirect limit, and maximum response size. + + :param source_url: URL of the source document. + :returns: HTTP response and response body. + :raises SourceGoneError: If the source returns HTTP 410. + :raises RetryableFetchError: If the source returns a temporary HTTP error. + :raises VerificationError: If the source returns another unsuccessful HTTP status or + exceeds the configured maximum response size. + """ + try: + with ( + build_public_http_client( + f"{APP_NAME}/{VERSION} ReceivedWebmention", + accept="text/html, application/xhtml+xml;q=0.9, text/plain;q=0.8", + ) as client, + client.stream("GET", source_url) as response, + ): + if response.status_code == HTTPStatus.OK: + pass + elif response.status_code == HTTPStatus.GONE: + raise SourceGoneError("Source returned HTTP 410") + elif is_retryable_status(response.status_code): + raise RetryableFetchError( + f"Source returned HTTP {response.status_code}" + ) + else: + raise VerificationError(f"Source returned HTTP {response.status_code}") + + try: + return response, read_limited_body( + response, + current_app.config["MAX_RECEIVED_SOURCE_BYTES"], + label="Source", + ) + except ResponseTooLargeError as exc: + raise VerificationError(str(exc)) from exc + + except UnsafeAddressError as exc: + raise VerificationError("Source resolves to a non-public address") from exc + except AddressResolutionError as exc: + raise RetryableFetchError("Source hostname could not be resolved") from exc + + +def source_mentions_target(source_url: str, target_url: str) -> bool: + """Fetch a source and check whether it mentions the target URL. + + HTML and XHTML sources are inspected for supported URL attributes, while + plain-text sources are searched for the exact target IRI. + + :param source_url: URL of the source document. + :param target_url: Exact target URL to look for. + :returns: Whether the source mentions the target URL. + :raises VerificationError: If the source has an unsupported or missing content type. + :raises SourceGoneError: If the source explicitly reports that it is gone. + :raises RetryableFetchError: If fetching the source fails temporarily. + """ + response, body = fetch_source_document(source_url) + + media_type = media_type_of(response.headers) + + match media_type: + case "text/html" | "application/xhtml+xml": + return html_mentions_target(body, str(response.url), target_url) + case "text/plain": + try: + decoded_body = body.decode( + response.encoding or "utf-8", errors="replace" + ) + except LookupError: + decoded_body = body.decode("utf-8", errors="replace") + return text_mentions_target(decoded_body, target_url) + case _: + raise VerificationError( + f"Unsupported source content type: {media_type or 'missing'}" + ) + + +@dataclass(frozen=True) +class VerificationClaim: + """Source and lease version for one atomically claimed verification.""" + + webmention_uuid: uuid.UUID + source: str + target: str + lease_started_at: datetime + + +def claim_for_verification(webmention_uuid: uuid.UUID) -> VerificationClaim | None: + """Claim an eligible row, returning its source, target, and lease version. + + :param webmention_uuid: Identifier of the received Webmention to claim. + :returns: Verification claim, or ``None`` if the row cannot be claimed. + """ + webmention = db.session.get(ReceivedWebmention, webmention_uuid) + + if webmention is None: + current_app.logger.warning( + "Cannot verify unknown ReceivedWebmention %s", webmention_uuid + ) + return None + + if webmention.status not in { + ReceivedWebmentionStatus.RECEIVED, + ReceivedWebmentionStatus.FAILED, + }: + return None + + if ( + webmention.status == ReceivedWebmentionStatus.FAILED + and webmention.failure_reason == RECOVERY_EXHAUSTED_REASON + ): + return None + + claim = VerificationClaim( + webmention_uuid=webmention_uuid, + source=webmention.source, + target=webmention.target, + lease_started_at=datetime.now(UTC), + ) + changed = db.session.execute( + sa.update(ReceivedWebmention) + .where( + ReceivedWebmention.uuid == webmention_uuid, + ReceivedWebmention.status == webmention.status, + ReceivedWebmention.updated_at == webmention.updated_at, + ) + .values( + status=ReceivedWebmentionStatus.VERIFYING, + failure_reason=None, + updated_at=claim.lease_started_at, + ) + ) + + if rows_affected(changed) != 1: + db.session.rollback() + return None + + db.session.commit() + return claim + + +def determine_verification_outcome( + claim: VerificationClaim, +) -> tuple[ReceivedWebmentionStatus, str | None]: + """Map verification results and permanent errors to a final status/reason. + + :param claim: Claim containing the source and target URLs to verify. + :returns: Final verification status and optional reason. + :raises RetryableFetchError: If the source fetch fails transiently and should be + retried. + :raises httpx.RequestError: If a transient HTTP request error should be retried. + """ + try: + mentions_target = source_mentions_target(claim.source, claim.target) + except SourceGoneError as exc: + return ReceivedWebmentionStatus.SOURCE_REMOVED, str(exc) + except VerificationError as exc: + return ReceivedWebmentionStatus.FAILED, str(exc) + except RetryableFetchError, httpx.RequestError: + raise # These errors must be persisted and then retried by Huey. + except Exception as exc: + # InvalidURL is not a RequestError; unexpected source errors are terminal. + current_app.logger.exception( + "Unexpected error verifying ReceivedWebmention %s", claim.webmention_uuid + ) + return ReceivedWebmentionStatus.FAILED, str(exc) or type(exc).__name__ + + if mentions_target: + return ReceivedWebmentionStatus.VERIFIED, None + return ReceivedWebmentionStatus.SOURCE_REMOVED, "Source does not mention target" + + +def store_verification_outcome( + claim: VerificationClaim, status: ReceivedWebmentionStatus, reason: str | None +) -> bool: + """Persist an outcome only if this worker still owns the verification lease. + + :param claim: Verification lease acquired by this worker. + :param status: Final status to persist for the claimed Webmention. + :param reason: Optional explanation for a failed or source-removed Webmention. + :returns: ``True`` if the worker still owned the lease and persisted the outcome. + """ + changed = db.session.execute( + sa.update(ReceivedWebmention) + .where( + ReceivedWebmention.uuid == claim.webmention_uuid, + ReceivedWebmention.status == ReceivedWebmentionStatus.VERIFYING, + ReceivedWebmention.updated_at == claim.lease_started_at, + ) + .values(status=status, failure_reason=reason, updated_at=datetime.now(UTC)) + ) + db.session.commit() + return rows_affected(changed) == 1 + + +@huey.task(retries=2, retry_delay=50) +def verify_webmention(webmention_uuid: uuid.UUID) -> None: + """Claim and verify a received Webmention, preserving its lease on release. + + Temporary fetch failures are recorded and re-raised for Huey's retries. + + Retry transient fetch errors; persist only results belonging to the currently held + lease. + + :param webmention_uuid: Identifier of the received webmention to verify. + :raises RetryableFetchError: If fetching the source fails temporarily. + :raises httpx.RequestError: If an HTTP request fails while fetching. + """ + if (claim := claim_for_verification(webmention_uuid)) is None: + return + + try: + status, reason = determine_verification_outcome(claim) + except (RetryableFetchError, httpx.RequestError) as exc: + store_verification_outcome( + claim, + ReceivedWebmentionStatus.FAILED, + str(exc) or "Source could not be fetched", + ) + raise + + store_verification_outcome(claim, status, reason) + + +def recover_stale_verifications() -> int: + """Requeue verification attempts that were abandoned or lost from the queue. + + Recover both stale ``verifying`` rows (workers that died) and stale + ``received`` rows (tasks that were never enqueued or were lost). Conditional + updates prevent overlapping reapers from enqueueing the same row. Each + reclaimed row is committed *before* enqueueing, so the worker can claim it. + A crash between commit and enqueue is recovered on a later sweep. + Persist a recovery count so repeatedly lost or crashing tasks eventually + terminate rather than being requeued forever. + + Eligible expired verification leases are returned to the queue, subject to recovery + limits. + + :returns: Number of webmentions requeued. + """ + now = datetime.now(UTC) + cutoff = now - timedelta( + seconds=current_app.config["VERIFICATION_STALE_AFTER_SECONDS"] + ) + + stale = db.session.execute( + sa.select( + ReceivedWebmention.uuid, + ReceivedWebmention.status, + ReceivedWebmention.updated_at, + ReceivedWebmention.recovery_attempts, + ).where( + ReceivedWebmention.status.in_( + (ReceivedWebmentionStatus.VERIFYING, ReceivedWebmentionStatus.RECEIVED) + ), + ReceivedWebmention.updated_at <= cutoff, + ) + ).all() + + recovered = 0 + exhausted = 0 + max_recoveries = current_app.config["VERIFICATION_MAX_RECOVERIES"] + + for identifier, status, updated_at, recovery_attempts in stale: + at_limit = recovery_attempts >= max_recoveries + changed = db.session.execute( + sa.update(ReceivedWebmention) + .where( + ReceivedWebmention.uuid == identifier, + ReceivedWebmention.status == status, + ReceivedWebmention.updated_at == updated_at, + ReceivedWebmention.recovery_attempts == recovery_attempts, + ) + .values( + **( + { + "status": ReceivedWebmentionStatus.FAILED, + "failure_reason": RECOVERY_EXHAUSTED_REASON, + "updated_at": now, + "recovery_attempts": recovery_attempts, + } + if at_limit + else ReceivedWebmention.reopen_verification_values( + at=now, recovery_attempts=recovery_attempts + 1 + ) + ) + ) + ) + + if rows_affected(changed) != 1: + db.session.rollback() + continue + + db.session.commit() + + if at_limit: + exhausted += 1 + continue + verify_webmention(identifier) + recovered += 1 + + if exhausted: + current_app.logger.warning( + "Failed %d stale webmentions after maximum verification recoveries", + exhausted, + ) + + if recovered: + current_app.logger.warning( + "Requeued %d stale received webmention verifications", recovered + ) + + return recovered |
