fix: wekeo_main order/download (#25)

Author: cauriol

stac_fastapi/eodag/config.py

@@ -43,6 +43,13 @@ class Settings(ApiSettings):
         description=("Hide from clients items assets' origin URLs starting with URLs from the list"),
     )
 
+    auto_order_whitelist: Annotated[Union[str, list[str]], BeforeValidator(str2liststr)] = Field(
+        default=[
+            "wekeo_main",
+        ],
+        description=("Do the order at the same time as the download"),
+    )
+
     fetch_providers: bool = Field(default=False, description="Fetch additional collections from all providers.")
 
     download_base_url: str = Field(

stac_fastapi/eodag/extensions/data_download.py

@@ -35,6 +35,7 @@
 from stac_fastapi.types.extension import ApiExtension
 from stac_fastapi.types.search import APIRequest
 
+from stac_fastapi.eodag.config import get_settings
 from stac_fastapi.eodag.errors import (
     DownloadError,
     MisconfiguredError,
@@ -119,6 +120,26 @@ def get_data(
                 f"Could not find {item_id} item in {product_type} collection",
                 f" for backend {federation_backend}.",
             )
+
+        settings = get_settings()
+        auto_order_whitelist = settings.auto_order_whitelist
+        if federation_backend in auto_order_whitelist:
+            logger.info(f"Provider {federation_backend} is whitelisted, ordering product before download")
+
+            auth = product.downloader_auth.authenticate() if product.downloader_auth else None
+            logger.debug(f"Polling product {product}")
+            try:
+                product.downloader.order(product=product, auth=auth)  # type: ignore
+            # when a NotAvailableError is catched, it means the product is not ready and still needs to be polled
+            except NotAvailableError:
+                product.properties["storageStatus"] = STAGING_STATUS
+            except Exception as e:
+                if (
+                    isinstance(e, DownloadError) or isinstance(e, ValidationError)
+                ) and "order status could not be checked" in e.args[0]:
+                    raise NotFoundError(f"Item {item_id} does not exist. Please order it first") from e
+                raise NotFoundError(e) from e
+
         auth = product.downloader_auth.authenticate() if product.downloader_auth else None
 
         if product.downloader is None:

stac_fastapi/eodag/models/stac_metadata.py

@@ -289,7 +289,12 @@ def create_stac_item(
         else None
     )
     # create assets only if product is not offline
-    if product.properties.get("storageStatus", ONLINE_STATUS) != OFFLINE_STATUS:
+    settings = get_settings()
+    auto_order_whitelist = settings.auto_order_whitelist
+    if (
+        product.properties.get("storageStatus", ONLINE_STATUS) != OFFLINE_STATUS
+        or product.provider in auto_order_whitelist
+    ):
         for k, v in product.assets.items():
             # TODO: download extension with origin link (make it optional ?)
             asset_model = model.model_validate(v)
@@ -339,7 +344,7 @@ def create_stac_item(
 
     feature["stac_extensions"] = list(stac_extensions)
 
-    if extension_names:
+    if extension_names and product.provider not in auto_order_whitelist:
         if "CollectionOrderExtension" in extension_names and (
             not product.properties.get("orderLink", False)
             or feature["properties"].get("order:status", "") != "orderable"

stac_fastapi/eodag/telemetry.py

@@ -33,9 +33,12 @@
 )
 from opentelemetry.sdk.metrics._internal.export import PeriodicExportingMetricReader
 from opentelemetry.sdk.metrics._internal.view import View
-from opentelemetry.sdk.resources import SERVICE_NAME, Resource
+
+# See https://github.com/open-telemetry/opentelemetry-python/issues/4615 for the type ignore
+from opentelemetry.sdk.resources import Resource  # type: ignore[attr-defined]
 from opentelemetry.sdk.trace import TracerProvider
 from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.semconv.resource import ResourceAttributes
 
 if TYPE_CHECKING:
     from fastapi import FastAPI
@@ -128,7 +131,7 @@ def instrument_fastapi(
 ) -> None:
     """Instrument FastAPI app."""
     logger.info("Instrument FastAPI app")
-    resource = Resource(attributes={SERVICE_NAME: "stac-fastapi-eodag"})
+    resource = Resource(attributes={ResourceAttributes.SERVICE_NAME: "stac-fastapi-eodag"})
     tracer_provider = create_tracer_provider(resource)
     meter_provider = create_meter_provider(resource)
     FastAPIInstrumentor.instrument_app(
@@ -141,7 +144,7 @@ def instrument_fastapi(
 def instrument_eodag(eodag_api: EODataAccessGateway):
     """Instrument EODAG app"""
     logger.info("Instrument EODAG app")
-    resource = Resource(attributes={SERVICE_NAME: "stac-fastapi-eodag"})
+    resource = Resource(attributes={ResourceAttributes.SERVICE_NAME: "stac-fastapi-eodag"})
     tracer_provider = create_tracer_provider(resource)
     meter_provider = create_meter_provider(resource)
     EODAGInstrumentor(eodag_api).instrument(

tests/conftest.py

@@ -326,6 +326,14 @@ def mock_base_stream_download_dict(mocker):
     return mocker.patch.object(Download, "_stream_download_dict")
 
 
+@pytest.fixture(scope="function")
+def mock_http_base_stream_download_dict(mocker):
+    """
+    Mocks the `_stream_download_dict` method of the `Download` plugin.
+    """
+    return mocker.patch.object(HTTPDownload, "_stream_download_dict")
+
+
 @pytest.fixture(scope="function")
 def mock_order(mocker):
     """

tests/test_download.py

@@ -19,6 +19,13 @@
 
 import os
 
+from eodag import SearchResult
+from eodag.api.product import EOProduct
+from eodag.config import PluginConfig
+from eodag.plugins.download.http import HTTPDownload
+
+from stac_fastapi.eodag.config import get_settings
+
 
 async def test_download_item_from_collection_stream(
     request_valid_raw, defaults, mock_base_stream_download_dict, mock_base_authenticate, stream_response
@@ -46,3 +53,48 @@ async def test_download_item_from_collection_no_stream(
     mock_download.assert_called_once()
     # downloaded file should have been immediatly deleted from the server
     assert not os.path.exists(expected_file), f"File {expected_file} should have been deleted"
+
+
+async def test_download_auto_order_whitelist(
+    request_valid_raw,
+    mock_base_authenticate,
+    mock_order,
+    mock_search,
+    defaults,
+    mock_http_base_stream_download_dict,
+    stream_response,
+):
+    """Test that the order method is called when downloading a product
+    from a federation backend included in the auto_order_whitelist.
+
+    This test simulates downloading a product from a federated backend ('peps')
+    and checks that the order function is triggered when the backend is present
+    in the auto_order_whitelist configuration.
+    """
+    get_settings().auto_order_whitelist = ["peps"]
+    federation_backend = "peps"
+    collection_id = defaults.product_type
+
+    url = f"data/peps/{defaults.product_type}/dummy_id/downloadLink"
+
+    product = EOProduct(
+        federation_backend,
+        dict(
+            geometry="POINT (0 0)",
+            title="dummy_product",
+            id="dummy_id",
+        ),
+    )
+    product.product_type = collection_id
+    config = PluginConfig()
+    config.priority = 0
+    downloader = HTTPDownload("peps", config)
+
+    product.register_downloader(downloader=downloader, authenticator=None)
+
+    mock_search.return_value = SearchResult([product])
+    mock_http_base_stream_download_dict.return_value = stream_response
+
+    await request_valid_raw(url, search_result=SearchResult([product]))
+
+    assert mock_order.called