Merge pull request #1597 from VWS-Python/test-deleted-fix-hang

Test deleted fix hang

Author: adamtheturtle

docs/source/differences-to-vws.rst

@@ -37,21 +37,6 @@ The criteria for these images is not defined by the Vuforia documentation.
 The mock is more forgiving than the real Vuforia Web Services.
 Therefore, an image given a 'success' status by the mock may not be given a 'success' status by the real Vuforia Web Services.
 
-Matching targets in the processing state
-----------------------------------------
-
-Matching a target which is in the processing state sometimes returns a successful response with no results.
-Sometimes a 500 (``INTERNAL SERVER ERROR``) response is given.
-The mock always gives a 500 response.
-
-Matching deleted targets
-------------------------
-
-Matching a target which has been deleted returns a 500 (``INTERNAL SERVER ERROR``) response within the first few seconds.
-This time frame is not consistent on the real Vuforia Web Services.
-On the mock, this time frame is three seconds by default.
-:py:class:`~mock_vws.MockVWS` takes a parameter :paramref:`~mock_vws.MockVWS.query_processes_deletion_seconds` to change this.
-
 Accepted date formats for the Query API
 ---------------------------------------
 

docs/source/docker.rst

@@ -118,20 +118,6 @@ Target manager container
 Query container
 ~~~~~~~~~~~~~~~
 
-.. envvar:: DELETION_PROCESSING_SECONDS
-
-   The number of seconds after a target deletion is recognized that the
-   query endpoint will return a 500 response on a match.
-
-   Default: 3.0
-
-.. envvar:: DELETION_RECOGNITION_SECONDS
-
-   The number of seconds after a target has been deleted that the query
-   endpoint will still recognize the target for.
-
-   Default: 2.0
-
 .. envvar:: QUERY_IMAGE_MATCHER
 
    The matcher to use for the query endpoint.

pyproject.toml

@@ -277,7 +277,6 @@ dependencies = [
     "requests-mock",
     "tzdata; sys_platform == 'win32'",
     "vws-auth-tools",
-    "werkzeug",
 ]
 
 [project.optional-dependencies]
@@ -319,7 +318,10 @@ dev = [
     "types-PyYAML==6.0.12.9",
     "types-Pillow==9.5.0.4",
     "types-requests==2.30.0.0",
-    "urllib3==2.0.2",
+    # We need urllib3 < 2.0.0 for pdm to work.
+    # After we can bump urllib3, we can remove types-urllib.
+    "types-urllib3==1.26.25.13",
+    "urllib3<2.0.0",
     "vulture==2.7",
     "vws-python==2023.3.25",
 ]

src/mock_vws/_flask_server/vwq.py

@@ -10,17 +10,14 @@
 from http import HTTPStatus
 
 import requests
-import werkzeug
 from flask import Flask, Response, request
 from pydantic import BaseSettings
 
 from mock_vws._query_tools import (
-    ActiveMatchingTargetsDeleteProcessing,
     get_query_match_response_text,
 )
 from mock_vws._query_validators import run_query_validators
 from mock_vws._query_validators.exceptions import (
-    DeletedTargetMatched,
     ValidatorException,
 )
 from mock_vws.database import VuforiaDatabase
@@ -55,8 +52,6 @@ class VWQSettings(BaseSettings):
 
     vwq_host: str = ""
     target_manager_base_url: str
-    deletion_processing_seconds: float = 3.0
-    deletion_recognition_seconds: float = 2.0
     query_image_matcher: _ImageMatcherChoice = _ImageMatcherChoice.AVERAGE_HASH
 
 
@@ -105,7 +100,8 @@ def handle_exceptions(exc: ValidatorException) -> Response:
         headers=exc.headers,
     )
 
-    response.headers = werkzeug.datastructures.Headers(exc.headers)
+    response.headers.clear()
+    response.headers.extend(exc.headers)
     return response
 
 
@@ -128,21 +124,14 @@ def query() -> Response:
     )
     date = email.utils.formatdate(None, localtime=False, usegmt=True)
 
-    try:
-        response_text = get_query_match_response_text(
-            request_headers=dict(request.headers),
-            request_body=request_body,
-            request_method=request.method,
-            request_path=request.path,
-            databases=databases,
-            query_processes_deletion_seconds=settings.deletion_processing_seconds,
-            query_recognizes_deletion_seconds=(
-                settings.deletion_recognition_seconds
-            ),
-            query_match_checker=query_match_checker,
-        )
-    except ActiveMatchingTargetsDeleteProcessing as exc:
-        raise DeletedTargetMatched from exc
+    response_text = get_query_match_response_text(
+        request_headers=dict(request.headers),
+        request_body=request_body,
+        request_method=request.method,
+        request_path=request.path,
+        databases=databases,
+        query_match_checker=query_match_checker,
+    )
 
     headers = {
         "Content-Type": "application/json",

src/mock_vws/_flask_server/vws.py

@@ -14,7 +14,6 @@
 from http import HTTPStatus
 
 import requests
-import werkzeug
 from flask import Flask, Response, request
 from pydantic import BaseSettings
 
@@ -134,7 +133,8 @@ def handle_exceptions(exc: ValidatorException) -> Response:
         headers=exc.headers,
     )
 
-    response.headers = werkzeug.datastructures.Headers(exc.headers)
+    response.headers.clear()
+    response.headers.extend(exc.headers)
     return response
 
 

src/mock_vws/_query_tools.py

@@ -24,20 +24,12 @@
     from mock_vws.image_matchers import ImageMatcher
 
 
-class ActiveMatchingTargetsDeleteProcessing(Exception):
-    """
-    There is at least one active target which matches and was recently deleted.
-    """
-
-
 def get_query_match_response_text(
     request_headers: dict[str, str],
     request_body: bytes,
     request_method: str,
     request_path: str,
     databases: set[VuforiaDatabase],
-    query_processes_deletion_seconds: int | float,
-    query_recognizes_deletion_seconds: int | float,
     query_match_checker: ImageMatcher,
 ) -> str:
     """
@@ -47,21 +39,11 @@ def get_query_match_response_text(
         request_body: The body of the request.
         request_method: The HTTP method of the request.
         databases: All Vuforia databases.
-        query_recognizes_deletion_seconds: The number of seconds after a target
-            has been deleted that the query endpoint will still recognize the
-            target for.
-        query_processes_deletion_seconds: The number of seconds after a target
-            deletion is recognized that the query endpoint will return a 500
-            response on a match.
         query_match_checker: A callable which takes two image values and
             returns whether they match.
 
     Returns:
         The response text for a query endpoint request.
-
-    Raises:
-        ActiveMatchingTargetsDeleteProcessing: There is at least one active
-            target which matches and was recently deleted.
     """
     body_file = io.BytesIO(request_body)
 
@@ -88,15 +70,7 @@ def get_query_match_response_text(
     assert image_part is not None
     image_value = image_part.raw
     gmt = ZoneInfo("GMT")
-    now = datetime.datetime.now(tz=gmt)
-
-    processing_timedelta = datetime.timedelta(
-        seconds=query_processes_deletion_seconds,
-    )
-
-    recognition_timedelta = datetime.timedelta(
-        seconds=query_recognizes_deletion_seconds,
-    )
+    datetime.datetime.now(tz=gmt)
 
     database = get_database_matching_client_keys(
         request_headers=request_headers,
@@ -125,28 +99,7 @@ def get_query_match_response_text(
         and target.status == TargetStatuses.SUCCESS.value
     ]
 
-    deletion_not_recognized_matches = [
-        target
-        for target in matching_targets
-        if target.active_flag
-        and target.delete_date
-        and (now - target.delete_date) < recognition_timedelta
-    ]
-
-    active_matching_targets_delete_processing = [
-        target
-        for target in matching_targets
-        if target.active_flag
-        and target.delete_date
-        and (now - target.delete_date)
-        < (recognition_timedelta + processing_timedelta)
-        and target not in deletion_not_recognized_matches
-    ]
-
-    if active_matching_targets_delete_processing:
-        raise ActiveMatchingTargetsDeleteProcessing
-
-    all_quality_matches = not_deleted_matches + deletion_not_recognized_matches
+    all_quality_matches = not_deleted_matches
     minimum_rating = 0
     matches = [
         match

src/mock_vws/_query_validators/exceptions.py

@@ -6,7 +6,6 @@
 import textwrap
 import uuid
 from http import HTTPStatus
-from pathlib import Path
 
 from mock_vws._constants import ResultCodes
 from mock_vws._mock_common import json_dump
@@ -628,45 +627,6 @@ def __init__(self) -> None:  # pragma: no cover
         }
 
 
-class DeletedTargetMatched(ValidatorException):
-    """
-    Exception raised when target which was recently deleted is matched.
-    """
-
-    def __init__(self) -> None:
-        """
-        Attributes:
-            status_code: The status code to use in a response if this is
-                raised.
-            response_text: The response text to use in a response if this is
-                raised.
-        """
-        super().__init__()
-        self.status_code = HTTPStatus.INTERNAL_SERVER_ERROR
-        date = email.utils.formatdate(None, localtime=False, usegmt=True)
-        # We return an example 500 response.
-        # Each response given by Vuforia is different.
-        #
-        # Sometimes Vuforia will ignore matching targets with the
-        # processing status, but we choose to:
-        # * Do the most unexpected thing.
-        # * Be consistent with every response.
-        resources_dir = Path(__file__).parent.parent / "resources"
-        filename = "deleted_target_matched_response.html"
-        deleted_target_matched_resp_file = resources_dir / filename
-        self.response_text = Path(deleted_target_matched_resp_file).read_text(
-            encoding="utf-8",
-        )
-        self.headers = {
-            "Connection": "keep-alive",
-            "Content-Type": "text/html;charset=iso-8859-1",
-            "Server": "nginx",
-            "Cache-Control": "must-revalidate,no-cache,no-store",
-            "Date": date,
-            "Content-Length": str(len(self.response_text)),
-        }
-
-
 class NoContentType(ValidatorException):
     """
     Exception raised when a content type is either not given or is empty.

src/mock_vws/_requests_mock_server/decorators.py

@@ -43,8 +43,6 @@ def __init__(
         duplicate_match_checker: ImageMatcher = _AVERAGE_HASH_MATCHER,
         query_match_checker: ImageMatcher = _AVERAGE_HASH_MATCHER,
         processing_time_seconds: int | float = 2,
-        query_recognizes_deletion_seconds: int | float = 2,
-        query_processes_deletion_seconds: int | float = 3,
         target_tracking_rater: TargetTrackingRater = _BRISQUE_TRACKING_RATER,
         *,
         real_http: bool = False,
@@ -62,12 +60,6 @@ def __init__(
                 In the real Vuforia Web Services, this is not deterministic.
             base_vwq_url: The base URL for the VWQ API.
             base_vws_url: The base URL for the VWS API.
-            query_recognizes_deletion_seconds: The number
-                of seconds after a target has been deleted that the query
-                endpoint will still recognize the target for.
-            query_processes_deletion_seconds: The number of
-                seconds after a target deletion is recognized that the query
-                endpoint will return a 500 response on a match.
             query_match_checker: A callable which takes two image values and
                 returns whether they will match in a query request.
             duplicate_match_checker: A callable which takes two image values
@@ -104,12 +96,6 @@ def __init__(
 
         self._mock_vwq_api = MockVuforiaWebQueryAPI(
             target_manager=self._target_manager,
-            query_processes_deletion_seconds=(
-                query_processes_deletion_seconds
-            ),
-            query_recognizes_deletion_seconds=(
-                query_recognizes_deletion_seconds
-            ),
             query_match_checker=query_match_checker,
         )