Wait for real reco reports to become ready

Author: adamtheturtle

tests/mock_vws/test_reco_counts_report.py

@@ -121,14 +121,36 @@ def _request_reco_counts_report(
     )
 
 
+@retry(
+    wait=wait_fixed(wait=0.5),
+    stop=stop_after_delay(max_delay=60),
+    retry=retry_if_exception_type(exception_types=(_ReportNotReadyError,)),
+    reraise=True,
+)
+@beartype
+def _request_ready_reco_counts_report(
+    *,
+    vuforia_database: CloudDatabase,
+    month: str,
+) -> requests.Response:
+    """Request a report until the generated report is ready."""
+    response = _request_reco_counts_report(
+        vuforia_database=vuforia_database,
+        database_id=vuforia_database.database_id,
+        month=month,
+    )
+    if response.status_code == HTTPStatus.NOT_FOUND:
+        raise _ReportNotReadyError
+    return response
+
+
 @beartype
 def _presigned_url(*, vuforia_database: CloudDatabase, month: str) -> str:
     """Request a report for the given month and return its download
     URL.
     """
-    response = _request_reco_counts_report(
+    response = _request_ready_reco_counts_report(
         vuforia_database=vuforia_database,
-        database_id=vuforia_database.database_id,
         month=month,
     )
     assert response.status_code == HTTPStatus.OK
@@ -224,9 +246,8 @@ def test_reco_counts_report(
         """A report can be requested for the current and previous
         month.
         """
-        response = _request_reco_counts_report(
+        response = _request_ready_reco_counts_report(
             vuforia_database=vuforia_database,
-            database_id=vuforia_database.database_id,
             month=_month_offset_from_now(months=-months_ago),
         )
 

tests/mock_vws/utils/__init__.py

@@ -4,6 +4,7 @@
 import secrets
 from collections.abc import Mapping
 from dataclasses import dataclass
+from http import HTTPStatus
 from typing import Literal
 from urllib.parse import urljoin
 
@@ -13,6 +14,12 @@
 from PIL import Image
 from requests.exceptions import Timeout as RequestsTimeout
 from requests.structures import CaseInsensitiveDict
+from tenacity import (
+    retry,
+    retry_if_exception_type,
+    stop_after_delay,
+    wait_fixed,
+)
 from vws.response import Response
 
 from mock_vws._constants import ResultCodes
@@ -23,6 +30,11 @@
 _REQUEST_TIMEOUT_SECONDS = 5
 
 
+@beartype
+class _TransientRecoCountsNotFoundError(Exception):
+    """The real reco counts endpoint temporarily returned an HTML 404."""
+
+
 @beartype
 def _send_request(
     *,
@@ -63,6 +75,39 @@ def _send_request(
     )
 
 
+@retry(
+    wait=wait_fixed(wait=0.5),
+    stop=stop_after_delay(max_delay=60),
+    retry=retry_if_exception_type(
+        exception_types=(_TransientRecoCountsNotFoundError,),
+    ),
+    reraise=True,
+)
+@beartype
+def _send_endpoint_request(
+    *,
+    method: str,
+    url: str,
+    headers: Mapping[str, str],
+    data: bytes | str,
+) -> Response:
+    """Send an endpoint request, retrying a transient real-service 404."""
+    response = _send_request(
+        method=method,
+        url=url,
+        headers=headers,
+        data=data,
+    )
+    if (
+        url.startswith("https://vws.vuforia.com/imagetargets/databases/")
+        and url.endswith("/reports/recoCounts")
+        and response.status_code == HTTPStatus.NOT_FOUND
+        and response.headers.get("Content-Type", "").startswith("text/html")
+    ):
+        raise _TransientRecoCountsNotFoundError
+    return response
+
+
 @dataclass(frozen=True, kw_only=True)
 class Endpoint:
     """Details of endpoints to be called in tests.
@@ -103,7 +148,7 @@ class Endpoint:
     @beartype
     def send(self) -> Response:
         """Send the request."""
-        return _send_request(
+        return _send_endpoint_request(
             method=self.method,
             url=urljoin(base=self.base_url, url=self.path_url),
             headers=self.headers,