eodag 3.0.0b3__py3-none-any.whl → 3.1.0b1__py3-none-any.whl

eodag/rest/core.py

@@ -50,13 +50,10 @@ from eodag.rest.constants import (
     CACHE_KEY_COLLECTIONS,
     CACHE_KEY_QUERYABLES,
 )
+from eodag.rest.errors import ResponseSearchError
 from eodag.rest.stac import StacCatalog, StacCollection, StacCommon, StacItem
 from eodag.rest.types.eodag_search import EODAGSearch
-from eodag.rest.types.queryables import (
-    QueryablesGetParams,
-    StacQueryableProperty,
-    StacQueryables,
-)
+from eodag.rest.types.queryables import QueryablesGetParams, StacQueryables
 from eodag.rest.types.stac_search import SearchPostRequest
 from eodag.rest.utils import (
     Cruncher,
@@ -80,7 +77,7 @@ from eodag.utils.exceptions import (
 )
 
 if TYPE_CHECKING:
-    from typing import Any, Dict, List, Optional, Tuple, Union
+    from typing import Any, Dict, List, Optional, Union
 
     from fastapi import Request
     from requests.auth import AuthBase
@@ -133,17 +130,15 @@ def format_product_types(product_types: List[Dict[str, Any]]) -> str:
 def search_stac_items(
     request: Request,
     search_request: SearchPostRequest,
-    catalogs: Optional[List[str]] = None,
 ) -> Dict[str, Any]:
     """
-    Search and retrieve STAC items from the given catalogs.
+    Search and retrieve STAC items based on the given search request.
 
-    This function takes a search request and optional catalogs list, performs a search using EODAG API, and returns a
+    This function takes a search request, performs a search using EODAG API, and returns a
     dictionary of STAC items.
 
     :param request: The incoming HTTP request with state information.
-    :param search_request: The search criteria for STAC items.
-    :param catalogs: (optional) A list of catalogs to search within. Defaults to None.
+    :param search_request: The search criteria for STAC items
     :returns: A dictionary containing the STAC items and related metadata.
 
     The function handles the conversion of search criteria into STAC and EODAG compatible formats, validates the input
@@ -165,60 +160,54 @@ def search_stac_items(
     if search_request.spatial_filter:
         stac_args["geometry"] = search_request.spatial_filter
     try:
-        eodag_args = EODAGSearch.model_validate(
-            stac_args, context={"isCatalog": bool(catalogs)}
-        )
+        eodag_args = EODAGSearch.model_validate(stac_args)
     except pydanticValidationError as e:
         raise ValidationError(format_pydantic_error(e)) from e
 
     catalog_url = re.sub("/items.*", "", request.state.url)
-
     catalog = StacCatalog(
-        url=(
-            catalog_url
-            if catalogs
-            else catalog_url.replace(
-                "/search", f"/collections/{eodag_args.productType}"
-            )
-        ),
+        url=catalog_url.replace("/search", f"/collections/{eodag_args.productType}"),
         stac_config=stac_config,
         root=request.state.url_root,
         provider=eodag_args.provider,
         eodag_api=eodag_api,
-        catalogs=catalogs or [eodag_args.productType],  # type: ignore
+        collection=eodag_args.productType,  # type: ignore
     )
 
     # get products by ids
     if eodag_args.ids:
-        search_results = SearchResult([])
+        results = SearchResult([])
         for item_id in eodag_args.ids:
-            sr = eodag_api.search(
-                id=item_id,
-                productType=catalogs[0] if catalogs else eodag_args.productType,
-                provider=eodag_args.provider,
+            results.extend(
+                eodag_api.search(
+                    id=item_id,
+                    productType=eodag_args.productType,
+                    provider=eodag_args.provider,
+                )
             )
-            search_results.extend(sr)
-        search_results.number_matched = len(search_results)
-        total = len(search_results)
-
-    elif time_interval_overlap(eodag_args, catalog):
-        criteria = {
-            **catalog.search_args,
-            **eodag_args.model_dump(exclude_none=True),
-        }
+        results.number_matched = len(results)
+        total = len(results)
 
-        search_results = eodag_api.search(count=True, **criteria)
-        total = search_results.number_matched or 0
-        if search_request.crunch:
-            search_results = crunch_products(
-                search_results, search_request.crunch, **criteria
-            )
     else:
-        # return empty results
-        search_results = SearchResult([], 0)
-        total = 0
+        criteria = eodag_args.model_dump(exclude_none=True)
+        # remove provider prefixes
+        # quickfix for ecmwf fake extension to not impact items creation
+        stac_extensions = list(stac_config["extensions"].keys()) + ["ecmwf"]
+        for key in list(criteria):
+            if ":" in key and key.split(":")[0] not in stac_extensions:
+                new_key = key.split(":")[1]
+                criteria[new_key] = criteria.pop(key)
+
+        results = eodag_api.search(count=True, **criteria)
+        total = results.number_matched or 0
+
+    if len(results) == 0 and results.errors:
+        raise ResponseSearchError(results.errors)
+
+    if search_request.crunch:
+        results = crunch_products(results, search_request.crunch, **criteria)
 
-    for record in search_results:
+    for record in results:
         record.product_type = eodag_api.get_alias_from_product_type(record.product_type)
 
     items = StacItem(
@@ -228,7 +217,7 @@ def search_stac_items(
         eodag_api=eodag_api,
         root=request.state.url_root,
     ).get_stac_items(
-        search_results=search_results,
+        search_results=results,
         total=total,
         next_link=get_next_link(
             request, search_request, total, eodag_args.items_per_page
@@ -243,7 +232,7 @@ def search_stac_items(
 
 def download_stac_item(
     request: Request,
-    catalogs: List[str],
+    collection_id: str,
     item_id: str,
     provider: Optional[str] = None,
     asset: Optional[str] = None,
@@ -251,13 +240,13 @@ def download_stac_item(
 ) -> Response:
     """Download item
 
-    :param catalogs: Catalogs list (only first is used as product_type)
+    :param collection_id: id of the product type
     :param item_id: Product ID
     :param provider: (optional) Chosen provider
     :param kwargs: additional download parameters
     :returns: a stream of the downloaded data (zip file)
     """
-    product_type = catalogs[0]
+    product_type = collection_id
 
     search_results = eodag_api.search(
         id=item_id, productType=product_type, provider=provider, **kwargs
@@ -338,13 +327,11 @@ def _order_and_update(
     if (
         product.properties.get("storageStatus") != ONLINE_STATUS
         and NOT_AVAILABLE in product.properties.get("orderStatusLink", "")
-        and hasattr(product.downloader, "order_download")
+        and hasattr(product.downloader, "_order")
     ):
         # first order
         logger.debug("Order product")
-        order_status_dict = product.downloader.order_download(
-            product=product, auth=auth
-        )
+        order_status_dict = product.downloader._order(product=product, auth=auth)
         query_args.update(order_status_dict or {})
 
     if (
@@ -355,11 +342,11 @@ def _order_and_update(
         product.properties["storageStatus"] = STAGING_STATUS
 
     if product.properties.get("storageStatus") == STAGING_STATUS and hasattr(
-        product.downloader, "order_download_status"
+        product.downloader, "_order_status"
     ):
         # check order status if needed
         logger.debug("Checking product order status")
-        product.downloader.order_download_status(product=product, auth=auth)
+        product.downloader._order_status(product=product, auth=auth)
 
     if product.properties.get("storageStatus") != ONLINE_STATUS:
         raise NotAvailableError("Product is not available yet")
@@ -390,7 +377,7 @@ async def all_collections(
     :param root: The API root
     :param filters: Search collections filters
     :param provider: (optional) Chosen provider
-    :returns: Collections dictionnary
+    :returns: Collections dictionary
     """
 
     async def _fetch() -> Dict[str, Any]:
@@ -413,7 +400,10 @@ async def all_collections(
         # # parse f-strings
         format_args = deepcopy(stac_config)
         format_args["collections"].update(
-            {"url": stac_collection.url, "root": stac_collection.root}
+            {
+                "url": stac_collection.url,
+                "root": stac_collection.root,
+            }
         )
 
         collections["links"] = [
@@ -423,7 +413,9 @@ async def all_collections(
         collections = format_dict_items(collections, **format_args)
         return collections
 
-    hashed_collections = hash(f"{provider}:{q}:{platform}:{instrument}:{constellation}")
+    hashed_collections = hash(
+        f"{provider}:{q}:{platform}:{instrument}:{constellation}:{datetime}"
+    )
     cache_key = f"{CACHE_KEY_COLLECTIONS}:{hashed_collections}"
     return await cached(_fetch, cache_key, request)
 
@@ -462,14 +454,12 @@ async def get_collection(
 async def get_stac_catalogs(
     request: Request,
     url: str,
-    catalogs: Optional[Tuple[str, ...]] = None,
     provider: Optional[str] = None,
 ) -> Dict[str, Any]:
     """Build STAC catalog
 
     :param url: Requested URL
     :param root: (optional) API root
-    :param catalogs: (optional) Catalogs list
     :param provider: (optional) Chosen provider
     :returns: Catalog dictionary
     """
@@ -481,13 +471,9 @@ async def get_stac_catalogs(
             root=request.state.url_root,
             provider=provider,
             eodag_api=eodag_api,
-            catalogs=list(catalogs) if catalogs else None,
         ).data
 
-    hashed_catalogs = hash(":".join(catalogs) if catalogs else None)
-    return await cached(
-        _fetch, f"{CACHE_KEY_COLLECTION}:{provider}:{hashed_catalogs}", request
-    )
+    return await cached(_fetch, f"{CACHE_KEY_COLLECTION}:{provider}", request)
 
 
 def time_interval_overlap(eodag_args: EODAGSearch, catalog: StacCatalog) -> bool:
@@ -495,7 +481,10 @@ def time_interval_overlap(eodag_args: EODAGSearch, catalog: StacCatalog) -> bool
     # check if time filtering appears both in search arguments and catalog
     # (for catalogs built by date: i.e. `year/2020/month/05`)
     if not set(["start", "end"]) <= set(eodag_args.model_dump().keys()) or not set(
-        ["start", "end"]
+        [
+            "start",
+            "end",
+        ]
     ) <= set(catalog.search_args.keys()):
         return True
 
@@ -537,7 +526,7 @@ def time_interval_overlap(eodag_args: EODAGSearch, catalog: StacCatalog) -> bool
 def get_stac_conformance() -> Dict[str, str]:
     """Build STAC conformance
 
-    :returns: conformance dictionnary
+    :returns: conformance dictionary
     """
     return stac_config["conformance"]
 
@@ -555,7 +544,7 @@ def get_stac_extension_oseo(url: str) -> Dict[str, str]:
     """Build STAC OGC / OpenSearch Extension for EO
 
     :param url: Requested URL
-    :returns: Catalog dictionnary
+    :returns: Catalog dictionary
     """
 
     def apply_method(_: str, x: str) -> str:
@@ -591,41 +580,87 @@ async def get_queryables(
 
     async def _fetch() -> Dict[str, Any]:
         python_queryables = eodag_api.list_queryables(
-            provider=provider, **params.model_dump(exclude_none=True, by_alias=True)
+            provider=provider,
+            fetch_providers=False,
+            **params.model_dump(exclude_none=True, by_alias=True),
         )
-        python_queryables.pop("start")
-        python_queryables.pop("end")
-
-        # productType and id are already default in stac collection and id
-        python_queryables.pop("productType", None)
-        python_queryables.pop("id", None)
 
-        stac_queryables: Dict[str, StacQueryableProperty] = deepcopy(
-            StacQueryables.default_properties
+        python_queryables_json = python_queryables.get_model().model_json_schema(
+            by_alias=True
         )
-        for param, queryable in python_queryables.items():
-            stac_param = EODAGSearch.to_stac(param)
-            # only keep "datetime" queryable for dates
-            if stac_param in stac_queryables or stac_param in (
-                "start_datetime",
-                "end_datetime",
-            ):
-                continue
 
-            stac_queryables[
-                stac_param
-            ] = StacQueryableProperty.from_python_field_definition(
-                stac_param, queryable
-            )
+        properties: Dict[str, Any] = python_queryables_json["properties"]
+        required: List[str] = python_queryables_json.get("required") or []
 
-        if params.collection:
-            stac_queryables.pop("collection")
+        # productType is either simply removed or replaced by collection later.
+        if "productType" in properties:
+            properties.pop("productType")
+        if "productType" in required:
+            required.remove("productType")
+
+        stac_properties: Dict[str, Any] = {}
+
+        # get stac default properties to set prefixes
+        stac_item_properties = list(stac_config["item"]["properties"].values())
+        stac_item_properties.extend(stac_config["metadata_ignore"])
+        for param, queryable in properties.items():
+            # convert key to STAC format
+            if param in OSEO_METADATA_MAPPING.keys() and not any(
+                param in str(prop) for prop in stac_item_properties
+            ):
+                param = f"oseo:{param}"
+            stac_param = EODAGSearch.to_stac(param, stac_item_properties, provider)
+
+            queryable["title"] = stac_param.split(":")[-1]
+
+            # remove null default values
+            if not queryable.get("default"):
+                queryable.pop("default", None)
+
+            stac_properties[stac_param] = queryable
+            required = list(map(lambda x: x.replace(param, stac_param), required))
+
+        # due to certain metadata mappings we might only get end_datetime but we can
+        # assume that start_datetime is also available
+        if (
+            "end_datetime" in stac_properties
+            and "start_datetime" not in stac_properties
+        ):
+            stac_properties["start_datetime"] = deepcopy(
+                stac_properties["end_datetime"]
+            )
+            stac_properties["start_datetime"]["title"] = "start_datetime"
+        # if we can search by start_datetime we can search by datetime
+        if "start_datetime" in stac_properties:
+            stac_properties["datetime"] = StacQueryables.possible_properties[
+                "datetime"
+            ].model_dump()
+
+        # format spatial extend properties to STAC format.
+        if "geometry" in stac_properties:
+            stac_properties["bbox"] = StacQueryables.possible_properties[
+                "bbox"
+            ].model_dump()
+            stac_properties["geometry"] = StacQueryables.possible_properties[
+                "geometry"
+            ].model_dump()
+
+        if not params.collection:
+            stac_properties["collection"] = StacQueryables.default_properties[
+                "collection"
+            ].model_dump()
+
+        additional_properties = python_queryables.additional_properties
+        description = "Queryable names for the EODAG STAC API Item Search filter. "
+        description += python_queryables.additional_information
 
         return StacQueryables(
             q_id=request.state.url,
-            additional_properties=bool(not params.collection),
-            properties=stac_queryables,
-        ).model_dump(mode="json", by_alias=True)
+            additional_properties=additional_properties,
+            properties=stac_properties,
+            required=required or None,
+            description=description,
+        ).model_dump(mode="json", by_alias=True, exclude_none=True)
 
     hashed_queryables = hash(params.model_dump_json())
     return await cached(
@@ -691,11 +726,16 @@ def eodag_api_init() -> None:
             constellation: Union[str, List[str]] = ext_col.get("summaries", {}).get(
                 "constellation"
             )
+            processing_level: Union[str, List[str]] = ext_col.get("summaries", {}).get(
+                "processing:level"
+            )
             # Check if platform or constellation are lists and join them into a string if they are
             if isinstance(platform, list):
                 platform = ",".join(platform)
             if isinstance(constellation, list):
                 constellation = ",".join(constellation)
+            if isinstance(processing_level, list):
+                processing_level = ",".join(processing_level)
 
             update_fields = {
                 "title": ext_col.get("title"),
@@ -706,7 +746,7 @@ def eodag_api_init() -> None:
                 ),
                 "platform": constellation,
                 "platformSerialIdentifier": platform,
-                "processingLevel": ext_col.get("summaries", {}).get("processing:level"),
+                "processingLevel": processing_level,
                 "license": ext_col["license"],
                 "missionStartDate": ext_col["extent"]["temporal"]["interval"][0][0],
                 "missionEndDate": ext_col["extent"]["temporal"]["interval"][-1][1],

eodag/rest/errors.py

@@ -0,0 +1,181 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024, CS GROUP - France, https://www.csgroup.eu/
+#
+# This file is part of EODAG project
+#     https://www.github.com/CS-SI/EODAG
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import logging
+from typing import Dict, List, Tuple, Union
+
+from fastapi import FastAPI, Request
+from fastapi.responses import ORJSONResponse
+from starlette import status
+from starlette.exceptions import HTTPException as StarletteHTTPException
+
+from eodag.rest.types.eodag_search import EODAGSearch
+from eodag.utils.exceptions import (
+    AuthenticationError,
+    DownloadError,
+    EodagError,
+    MisconfiguredError,
+    NoMatchingProductType,
+    NotAvailableError,
+    RequestError,
+    TimeOutError,
+    UnsupportedProductType,
+    UnsupportedProvider,
+    ValidationError,
+)
+
+EODAG_DEFAULT_STATUS_CODES = {
+    AuthenticationError: status.HTTP_500_INTERNAL_SERVER_ERROR,
+    DownloadError: status.HTTP_500_INTERNAL_SERVER_ERROR,
+    MisconfiguredError: status.HTTP_500_INTERNAL_SERVER_ERROR,
+    NotAvailableError: status.HTTP_404_NOT_FOUND,
+    NoMatchingProductType: status.HTTP_404_NOT_FOUND,
+    TimeOutError: status.HTTP_504_GATEWAY_TIMEOUT,
+    UnsupportedProductType: status.HTTP_404_NOT_FOUND,
+    UnsupportedProvider: status.HTTP_404_NOT_FOUND,
+    ValidationError: status.HTTP_400_BAD_REQUEST,
+}
+
+logger = logging.getLogger("eodag.rest.server")
+
+
+class ResponseSearchError(Exception):
+    """Represent a EODAG search error response"""
+
+    def __init__(self, errors: List[Tuple[str, Exception]]) -> None:
+        self._errors = errors
+
+    @property
+    def errors(self) -> List[Dict[str, Union[str, int]]]:
+        """return errors as a list of dict"""
+        error_list: List[Dict[str, Union[str, int]]] = []
+        for name, exception in self._errors:
+
+            error_dict: Dict[str, Union[str, int]] = {
+                "provider": name,
+                "error": exception.__class__.__name__,
+            }
+
+            if exception.args:
+                error_dict["message"] = exception.args[0]
+
+            if len(exception.args) > 1:
+                error_dict["detail"] = " ".join([str(i) for i in exception.args[1:]])
+
+            error_dict["status_code"] = EODAG_DEFAULT_STATUS_CODES.get(
+                type(exception), getattr(exception, "status_code", 500)
+            )
+
+            if type(exception) in (MisconfiguredError, AuthenticationError):
+                logger.error("%s: %s", type(exception).__name__, str(exception))
+                error_dict[
+                    "message"
+                ] = "Internal server error: please contact the administrator"
+                error_dict.pop("detail", None)
+
+            if type(exception) is ValidationError:
+                for error_param in exception.parameters:
+                    stac_param = EODAGSearch.to_stac(error_param)
+                    exception.message = exception.message.replace(
+                        error_param, stac_param
+                    )
+                error_dict["message"] = exception.message
+
+            error_list.append(error_dict)
+
+        return error_list
+
+    @property
+    def status_code(self) -> int:
+        """get global errors status code"""
+        if len(self._errors) == 1 and type(self.errors[0]["status_code"]) is int:
+            return self.errors[0]["status_code"]
+
+        return 400
+
+
+async def response_search_error_handler(
+    request: Request, exc: Exception
+) -> ORJSONResponse:
+    """Handle ResponseSearchError exceptions"""
+    if not isinstance(exc, ResponseSearchError):
+        return starlette_exception_handler(request, exc)
+
+    return ORJSONResponse(
+        status_code=exc.status_code,
+        content={"errors": exc.errors},
+    )
+
+
+async def eodag_errors_handler(request: Request, exc: Exception) -> ORJSONResponse:
+    """Handler for EODAG errors"""
+    if not isinstance(exc, EodagError):
+        return starlette_exception_handler(request, exc)
+
+    exception_status_code = getattr(exc, "status_code", None)
+    default_status_code = exception_status_code or 500
+    code = EODAG_DEFAULT_STATUS_CODES.get(type(exc), default_status_code)
+
+    detail = f"{type(exc).__name__}: {str(exc)}"
+
+    if type(exc) in (MisconfiguredError, AuthenticationError, TimeOutError):
+        logger.error("%s: %s", type(exc).__name__, str(exc))
+
+    if type(exc) in (MisconfiguredError, AuthenticationError):
+        detail = "Internal server error: please contact the administrator"
+
+    if type(exc) is ValidationError:
+        for error_param in exc.parameters:
+            stac_param = EODAGSearch.to_stac(error_param)
+            exc.message = exc.message.replace(error_param, stac_param)
+        detail = exc.message
+
+    return ORJSONResponse(
+        status_code=code,
+        content={"description": detail},
+    )
+
+
+def starlette_exception_handler(request: Request, error: Exception) -> ORJSONResponse:
+    """Default errors handle"""
+    description = (
+        getattr(error, "description", None)
+        or getattr(error, "detail", None)
+        or str(error)
+    )
+    return ORJSONResponse(
+        status_code=getattr(error, "status_code", 500),
+        content={"description": description},
+    )
+
+
+def add_exception_handlers(app: FastAPI) -> None:
+    """Add exception handlers to the FastAPI application.
+
+    Args:
+        app: the FastAPI application.
+
+    Returns:
+        None
+    """
+    app.add_exception_handler(StarletteHTTPException, starlette_exception_handler)
+
+    app.add_exception_handler(RequestError, eodag_errors_handler)
+    for exc in EODAG_DEFAULT_STATUS_CODES:
+        app.add_exception_handler(exc, eodag_errors_handler)
+
+    app.add_exception_handler(ResponseSearchError, response_search_error_handler)