Add async request query functionality (#438)

* add utility for querying which async requests are running

* add tests

* fix docs

* rename function

Author: zigaLuksic

Diff for: sentinelhub/api/process.py

@@ -1,8 +1,13 @@
 """
 Implementation of `Sentinel Hub Process API interface <https://docs.sentinel-hub.com/api/latest/api/process/>`__.
 """
-from typing import Any, Dict, List, Optional, Tuple, Union
+from typing import Any, Dict, Iterable, List, Optional, Tuple, Union
 
+import requests
+
+from sentinelhub.exceptions import DownloadFailedException
+
+from ..config import SHConfig
 from ..constants import MimeType
 from ..download import SentinelHubDownloadClient
 from ..geometry import BBox, Geometry
@@ -29,7 +34,7 @@ def __init__(
         geometry: Optional[Geometry] = None,
         size: Optional[Tuple[int, int]] = None,
         resolution: Optional[Tuple[float, float]] = None,
-        **kwargs: Any
+        **kwargs: Any,
     ):
         """
         For details of certain parameters check the
@@ -163,7 +168,7 @@ def __init__(
         geometry: Optional[Geometry] = None,
         size: Optional[Tuple[int, int]] = None,
         resolution: Optional[Tuple[float, float]] = None,
-        **kwargs: Any
+        **kwargs: Any,
     ):
         """
         For details of certain parameters check the
@@ -283,3 +288,29 @@ def output(
             _update_other_args(request_output, other_args)
 
         return request_output
+
+
+def get_async_running_status(ids: Iterable[str], config: Optional[SHConfig] = None) -> Dict[str, bool]:
+    """Returns a mapping that describes which requests are running.
+
+    :param ids: A collection of async request IDs.
+    :param config: A custom instance of config class to override parameters from the saved configuration.
+    :return: A mapping that specifies whether a process is running for each of the IDs.
+    """
+    config = config or SHConfig()
+    client = SentinelHubDownloadClient(config=config)
+    result = {}
+    for request_id in ids:
+        try:
+            client.get_json_dict(f"{config.sh_base_url}/api/v1/async/process/{request_id}", use_session=True)
+            # A successful request means it's running
+            result[request_id] = True
+        except DownloadFailedException as exception:
+            code_not_found = requests.status_codes.codes.NOT_FOUND
+            # A 404 means it's not running
+            if exception.request_exception and exception.request_exception.response.status_code == code_not_found:
+                result[request_id] = False
+            else:
+                raise exception from exception
+
+    return result

Diff for: tests/api/test_process_async.py

@@ -3,15 +3,16 @@
 import datetime as dt
 
 import pytest
+import requests
 from requests_mock import Mocker
 
-from sentinelhub import CRS, BBox, DataCollection, MimeType, SentinelHubRequest
-from sentinelhub.api.process import AsyncProcessRequest
+from sentinelhub import CRS, BBox, DataCollection, MimeType, SentinelHubRequest, SHConfig
+from sentinelhub.api.process import AsyncProcessRequest, get_async_running_status
 
 pytestmark = pytest.mark.sh_integration
 
 
-def test_async_process_request_response(requests_mock: Mocker) -> None:
+def test_async_process_request_response(requests_mock: Mocker, config: SHConfig) -> None:
     """A test that mocks the response of the async process request."""
     evalscript = "some evalscript"
     time_interval = dt.date(year=2020, month=6, day=1), dt.date(year=2020, month=6, day=10)
@@ -29,6 +30,7 @@ def test_async_process_request_response(requests_mock: Mocker) -> None:
         ],
         delivery=AsyncProcessRequest.s3_specification(url="s3_my_bucket", access_key="foo", secret_access_key="bar"),
         bbox=bbox,
+        config=config,
     )
 
     requests_mock.post("/oauth/token", real_http=True)
@@ -38,3 +40,24 @@ def test_async_process_request_response(requests_mock: Mocker) -> None:
     )
 
     assert request.get_data() == [{"id": "beep", "status": "RUNNING"}]
+
+
+def test_which_async_requests_running(requests_mock: Mocker, config: SHConfig) -> None:
+    running_ids = ["a", "c", "d"]
+    nonrunning_ids = ["b", "e"]
+
+    requests_mock.post("/oauth/token", real_http=True)
+    for request_id in running_ids:
+        requests_mock.get(
+            f"/api/v1/async/process/{request_id}",
+            [{"json": {"id": request_id, "status": "RUNNING"}}],
+        )
+    for request_id in nonrunning_ids:
+        response_404 = requests.Response()
+        response_404.status_code = 404
+        requests_mock.get(
+            f"/api/v1/async/process/{request_id}", exc=requests.exceptions.HTTPError(response=response_404)
+        )
+
+    results = get_async_running_status("abcde", config=config)
+    assert results == {"a": True, "c": True, "d": True, "b": False, "e": False}