feat: poll api (#230)

* feat: Added methods 'poll' and 'poll_async' to SumoClient.

* chore: Added unit test for poll method.

* fix: (tests) Capture and show exception when uploading child document, so that we can figure out the error.

* fix: (tests) Use correct format (i.e, 32-digit hexadecimal number) for file.checksum_md5.

Author: rwiker

src/sumo/wrapper/sumo_client.py

@@ -2,6 +2,7 @@
 import contextlib
 import logging
 import re
+import time
 
 import httpx
 import jwt
@@ -372,7 +373,7 @@ def delete(self, path: str, params: dict = None) -> dict:
             params: query parameters, as dictionary
 
         Returns:
-            Sumo JSON resposne as a dictionary
+            Sumo JSON response as a dictionary
 
         Examples:
             Deleting object::
@@ -401,6 +402,46 @@ def _delete():
 
         return retryer(_delete)
 
+    def _get_retry_details(self, response_in):
+        assert response_in.status_code == 202, (
+            "Incorrect status code; expcted 202"
+        )
+        headers = response_in.headers
+        location = headers.get("location")
+        assert location is not None, "Missing header: Location"
+        assert location.startswith(self.base_url)
+        retry_after = headers.get("retry-after")
+        assert retry_after is not None, "Missing header: Retry-After"
+        location = location[len(self.base_url) :]
+        retry_after = int(retry_after)
+        return location, retry_after
+
+    def poll(
+        self, response_in: httpx.Response, timeout=None
+    ) -> httpx.Response:
+        """Poll a specific endpoint until a result is obtained.
+
+        Args:
+            response_in: httpx.Response from a previous request, with 'location' and 'retry-after' headers.
+
+        Returns:
+            A new httpx.response object.
+        """
+        location, retry_after = self._get_retry_details(response_in)
+        expiry = time.time() + timeout if timeout is not None else None
+        while True:
+            time.sleep(retry_after)
+            response = self.get(location)
+            if response.status_code != 202:
+                return response
+            if expiry is not None and time.time() > expiry:
+                raise httpx.TimeoutException(
+                    "No response within specified timeout."
+                )
+            location, retry_after = self._get_retry_details(response)
+            pass
+        return None  # should never get here.
+
     def getLogger(self, name):
         """Gets a logger object that sends log objects into the message_log
         index for the Sumo instance.
@@ -642,7 +683,7 @@ async def delete_async(self, path: str, params: dict = None) -> dict:
             params: query parameters, as dictionary
 
         Returns:
-            Sumo JSON resposne as a dictionary
+            Sumo JSON response as a dictionary
 
         Examples:
             Deleting object::
@@ -670,3 +711,29 @@ async def _delete():
         retryer = self._retry_strategy.make_retryer_async()
 
         return await retryer(_delete)
+
+    async def poll_async(
+        self, response_in: httpx.Response, timeout=None
+    ) -> httpx.Response:
+        """Poll a specific endpoint until a result is obtained.
+
+        Args:
+            response_in: httpx.Response from a previous request, with 'location' and 'retry-after' headers.
+
+        Returns:
+            A new httpx.response object.
+        """
+        location, retry_after = self._get_retry_details(response_in)
+        expiry = time.time() + timeout if timeout is not None else None
+        while True:
+            await asyncio.sleep(retry_after)
+            response = await self.get_async(location)
+            if response.status_code != 202:
+                return response
+            if expiry is not None and time.time() > expiry:
+                raise httpx.TimeoutException(
+                    "No response within specified timeout."
+                )
+            location, retry_after = self._get_retry_details(response)
+            pass
+        return None  # should never get here.

tests/test_sumo_thin_client.py

@@ -112,9 +112,13 @@ def test_upload_search_delete_ensemble_child(token):
 
     fmu_surface_metadata["fmu"]["case"]["uuid"] = case_uuid
 
-    response_surface = _upload_child_level_json(
-        conn=sumo_client, parent_id=case_id, json=fmu_surface_metadata
-    )
+    try:
+        response_surface = _upload_child_level_json(
+            conn=sumo_client, parent_id=case_id, json=fmu_surface_metadata
+        )
+    except Exception as ex:
+        print(ex.response.text)
+        raise ex
 
     assert 200 <= response_surface.status_code <= 202
     assert isinstance(response_surface.json(), dict)
@@ -237,3 +241,12 @@ def test_upload_duplicate_ensemble(token):
     # Search for ensemble
     with pytest.raises(Exception):
         assert _download_object(conn, object_id=case_id2)
+
+
+def test_poll(token):
+    conn = SumoClient(env="dev", token=token)
+    res = conn.get("/admin/index/orphans")
+    res2 = conn.poll(res)
+    assert res2.status_code == 200
+    indexorphans = res2.json()
+    assert isinstance(indexorphans, list)

tests/testdata/surface.yml

@@ -75,7 +75,7 @@ fmu:
 file:
   relative_path: realization-33/iter-0/share/results/maps/volantis_gp_base--amplitude.gri # case-relative
   absolute_path: /some/absolute/path//realization-33/iter-0/share/results/maps/volantis_gp_base--amplitude.gri
-  checksum_md5: kjhsdfvsdlfk23knerknvk23  # checksum of the file, not the data.
+  checksum_md5: 0123456789abcdef0123456789abcdef  # checksum of the file, not the data.
 
 data: # The data block describes the actual data (e.g. surface). Only present in data objects