Merge pull request #625 from adamtheturtle/customisable-time

Document the 500 response for querying deleted targets

Author: adamtheturtle

CONTRIBUTING.rst

@@ -176,6 +176,8 @@ However, the maximum allowed value is 50.
 
 A response to an invalid query may have an ``application/json`` content type but include text (not JSON) data.
 
+After deleting a target, for up to approximately 30 seconds, matching it with a query returns a 500 response.
+
 Performing a release
 --------------------
 

README.rst

@@ -177,6 +177,13 @@ Matching a target which is in the processing state sometimes returns a successfu
 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 timeframe is not consistent on the real Vuforia Web Services.
+On the mock, this timeframe is always three seconds.
+
 .. |Build Status| image:: https://travis-ci.org/adamtheturtle/vws-python.svg?branch=master
    :target: https://travis-ci.org/adamtheturtle/vws-python
 .. |codecov| image:: https://codecov.io/gh/adamtheturtle/vws-python/branch/master/graph/badge.svg

src/mock_vws/_mock_web_query_api.py

@@ -462,11 +462,15 @@ def __init__(
             secret_key (str): A VWS client secret key.
             mock_web_services_api (MockVuforiaWebServicesAPI): An instance of a
                 mock web services API.
+            query_recognizes_deletion_seconds (int): The number of seconds
+                after a target has been deleted that the query endpoint will
+                return a 500 response for on a match.
         """
         self.routes: Set[Route] = ROUTES
         self.access_key: str = client_access_key
         self.secret_key: str = client_secret_key
         self.mock_web_services_api = mock_web_services_api
+        self.query_recognizes_deletion_seconds = 3
 
     @route(path_pattern='/v1/query', http_methods=[POST])
     def query(
@@ -497,9 +501,9 @@ def query(
         gmt = pytz.timezone('GMT')
         now = datetime.datetime.now(tz=gmt)
 
-        # See https://github.com/adamtheturtle/vws-python/issues/623 for making
-        # this customizable.
-        minimum_time_since_delete = datetime.timedelta(seconds=3)
+        minimum_time_since_delete = datetime.timedelta(
+            seconds=self.query_recognizes_deletion_seconds,
+        )
 
         for target in self.mock_web_services_api.targets:
             delete_processing = bool(