The confirmation wait time is fixed at 1200s

Problem:
20minutes is a long time to wait for failure. Tenant storage
assets should confirm more quckly and this setting must be
optionally settable by user.

Solution:
Specify new value via optional argument to Archivist() class. Setting
confirm=True when creating assets or events will then terminate after
this time if unconfirmed.

Signed-off-by: Paul Hewlett <phewlett76@gmail.com>

Author: eccles

archivist/archivist.py

@@ -56,6 +56,7 @@
 )
 
 from .assets import _AssetsClient
+from .confirmer import MAX_TIME
 from .events import _EventsClient
 from .locations import _LocationsClient
 from .attachments import _AttachmentsClient
@@ -86,6 +87,7 @@ class Archivist:  # pylint: disable=too-many-instance-attributes
         auth: string representing JWT token.
         cert: filepath containing both private key and certificate
         verify: if True the certificate is verified
+        max_time (int): maximum time in seconds to wait for confirmation
 
     Raises:
         ArchivistIllegalArgumentError: if neither 'auth' and 'cert' or if
@@ -103,6 +105,7 @@ def __init__(
         auth: Optional[str] = None,
         cert: Optional[str] = None,
         verify: bool = True,
+        max_time: int = MAX_TIME,
     ):
 
         self._headers = {"content-type": "application/json"}
@@ -126,6 +129,7 @@ def __init__(
         self._cert = cert
         self._response_ring_buffer = deque(maxlen=self.RING_BUFFER_MAX_LEN)
         self._session = requests.Session()
+        self._max_time = max_time
 
         # keep these in sync with CLIENTS map above
         self.assets: _AssetsClient
@@ -161,6 +165,11 @@ def verify(self) -> bool:
         """bool: Returns True if https connections are to be verified"""
         return self._verify
 
+    @property
+    def max_time(self) -> int:
+        """bool: Returns maximum time in seconds to wait for confirmation"""
+        return self._max_time
+
     @property
     def cert(self) -> Optional[str]:
         """str: filepath containing authorisation certificate."""

archivist/assets.py

@@ -38,10 +38,9 @@
     ASSETS_LABEL,
     CONFIRMATION_STATUS,
 )
-from .confirm import _wait_for_confirmation, _wait_for_confirmed
+from . import confirmer
 from .errors import ArchivistNotFoundError
 
-
 #: Default page size - number of entities fetched in one REST GET in the
 #: :func:`~_AssetsClient.list` method. This can be overridden but should rarely
 #: be changed.
@@ -166,7 +165,7 @@ def create_from_data(self, data: Dict, *, confirm: bool = False) -> Asset:
         if not confirm:
             return asset
 
-        return _wait_for_confirmation(self, asset["identity"])  # type: ignore
+        return self.wait_for_confirmation(asset["identity"])
 
     def wait_for_confirmation(self, identity: str) -> bool:
         """Wait for asset to be confirmed.
@@ -180,7 +179,9 @@ def wait_for_confirmation(self, identity: str) -> bool:
             True if asset is confirmed.
 
         """
-        return _wait_for_confirmation(self, identity)
+        confirmer.MAX_TIME = self._archivist.max_time
+        # pylint: disable=protected-access
+        return confirmer._wait_for_confirmation(self, identity)
 
     def read(self, identity: str) -> Asset:
         """Read asset
@@ -247,7 +248,9 @@ def wait_for_confirmed(
         if count == 0:
             raise ArchivistNotFoundError("No assets exist")
 
-        return _wait_for_confirmed(self, props=newprops, attrs=attrs)
+        confirmer.MAX_TIME = self._archivist.max_time
+        # pylint: disable=protected-access
+        return confirmer._wait_for_confirmed(self, props=newprops, attrs=attrs)
 
     def list(
         self,

archivist/confirm.py archivist/confirmer.pyarchivist/confirm.py renamed to archivist/confirmer.py

@@ -37,7 +37,7 @@
     CONFIRMATION_STATUS,
     EVENTS_LABEL,
 )
-from .confirm import _wait_for_confirmation, _wait_for_confirmed
+from . import confirmer
 from .errors import ArchivistNotFoundError
 
 
@@ -174,7 +174,7 @@ def create_from_data(self, asset_id: str, data: Dict, *, confirm=False) -> Event
         if not confirm:
             return event
 
-        return _wait_for_confirmation(self, event["identity"])  # type: ignore
+        return self.wait_for_confirmation(event["identity"])
 
     def wait_for_confirmation(self, identity: str) -> bool:
         """Wait for event to be confirmed.
@@ -188,7 +188,9 @@ def wait_for_confirmation(self, identity: str) -> bool:
             True if event is confirmed.
 
         """
-        return _wait_for_confirmation(self, identity)
+        confirmer.MAX_TIME = self._archivist.max_time
+        # pylint: disable=protected-access
+        return confirmer._wait_for_confirmation(self, identity)
 
     def read(self, identity: str) -> Event:
         """Read event
@@ -282,7 +284,9 @@ def wait_for_confirmed(
         if count == 0:
             raise ArchivistNotFoundError("No events exist")
 
-        return _wait_for_confirmed(
+        confirmer.MAX_TIME = self._archivist.max_time
+        # pylint: disable=protected-access
+        return confirmer._wait_for_confirmed(
             self, asset_id=asset_id, props=props, attrs=attrs, asset_attrs=asset_attrs
         )
 

archivist/events.py

@@ -90,10 +90,14 @@ def main():
     with open(".auth_token", mode="r") as tokenfile:
         authtoken = tokenfile.read().strip()
 
-    # Initialize connection to Archivist
+    # Initialize connection to Archivist. max_time is the time to wait for confirmation
+    # of an asset or event creation - the default is 1200 seconds but one can optionally
+    # specify a differnet value here particularly when creating assets on TENANT_STORAGE
+    # (rather than LEDGER) as confirmation times are much shorter in this case.
     arch = Archivist(
         "https://rkvst.poc.jitsuin.io",
         auth=authtoken,
+        max_time=300,
     )
     # Create a new asset
     asset = create_asset(arch)

examples/create_asset.py

@@ -8,7 +8,6 @@
 
 from archivist.archivist import Archivist
 from archivist.assets import DEFAULT_PAGE_SIZE
-from archivist import confirm
 from archivist.constants import (
     ASSETS_LABEL,
     ASSETS_SUBPATH,
@@ -125,12 +124,10 @@ class TestAssets(TestCase):
     maxDiff = None
 
     def setUp(self):
-        self.arch = Archivist("url", auth="authauthauth")
-        self.confirm_MAX_TIME = confirm.MAX_TIME
-        confirm.MAX_TIME = 2
+        self.arch = Archivist("url", auth="authauthauth", max_time=2)
 
     def tearDown(self):
-        confirm.MAX_TIME = self.confirm_MAX_TIME
+        self.arch = None
 
     def test_assets_create(self):
         """

unittests/testassets.py

@@ -6,7 +6,6 @@
 from unittest import TestCase, mock
 
 from archivist.archivist import Archivist
-from archivist import confirm
 from archivist.constants import (
     ROOT,
     ASSETS_LABEL,
@@ -231,12 +230,10 @@ class TestEvents(TestCase):
     maxDiff = None
 
     def setUp(self):
-        self.arch = Archivist("url", auth="authauthauth")
-        self.confirm_MAX_TIME = confirm.MAX_TIME
-        confirm.MAX_TIME = 2
+        self.arch = Archivist("url", auth="authauthauth", max_time=2)
 
     def tearDown(self):
-        confirm.MAX_TIME = self.confirm_MAX_TIME
+        self.arch = None
 
     def test_events_create(self):
         """