Merge remote-tracking branch 'origin/develop' into s1-ard-julien

Author: jgaucher-cs

services/cadip/rs_server_cadip/api/cadip_search.py

@@ -622,7 +622,7 @@ def process_files_search(  # pylint: disable=too-many-locals
         )
 
         if kwargs.get("map_to_session", False):
-            logger.debug(f"Retrieved products from CADIP station {station}: {products}")
+            # logger.debug(f"Retrieved products from CADIP station {station}: {products}")
             return [product.properties for product in products]
         cadip_item_collection = create_stac_collection(products, cadip_odata_to_stac_template(), cadip_stac_mapper())
         logger.debug(f"Retrieved item collection from CADIP station {station}: {cadip_item_collection}")

services/common/rs_server_common/fastapi_app.py

@@ -28,7 +28,10 @@
 from rs_server_common.authentication import oauth2
 from rs_server_common.authentication.authentication import authenticate
 from rs_server_common.authentication.oauth2 import AUTH_PREFIX
-from rs_server_common.middlewares import HandleExceptionsMiddleware
+from rs_server_common.middlewares import (
+    HandleExceptionsMiddleware,
+    StacLinksTitleMiddleware,
+)
 from rs_server_common.schemas.health_schema import HealthSchema
 from rs_server_common.settings import docs_params
 from rs_server_common.utils import init_opentelemetry
@@ -221,7 +224,7 @@ async def patched_landing_page(self, request, **kwargs):
 
     # This middleware allows to have consistant http/https protocol in stac links
     app.add_middleware(ProxyHeaderMiddleware)
-
+    app.add_middleware(StacLinksTitleMiddleware, title="My STAC Title")
     # Add CORS requests from the STAC browser
     if settings.CORS_ORIGINS:
         app.add_middleware(

services/common/rs_server_common/middlewares.py

@@ -13,12 +13,14 @@
 # limitations under the License.
 
 """Common functions for fastapi middlewares"""
+import json
 import os
 import traceback
 from collections.abc import Callable
 from typing import ParamSpec, TypedDict
+from urllib.parse import parse_qsl, urlencode, urlparse, urlunparse
 
-from fastapi import FastAPI, Request, status
+from fastapi import FastAPI, Request, Response, status
 from fastapi.responses import JSONResponse
 from rs_server_common import settings as common_settings
 from rs_server_common.authentication import authentication, oauth2
@@ -30,6 +32,24 @@
 from starlette.middleware.base import BaseHTTPMiddleware
 from starlette.middleware.sessions import SessionMiddleware
 
+REL_TITLES = {
+    "collection": "Collection",
+    "item": "Item",
+    "parent": "Parent Catalog",
+    "root": "STAC Root Catalog",
+    "conformance": "Conformance link",
+    "service-desc": "Service description",
+    "service-doc": "Service documentation",
+    "search": "Search endpoint",
+    "data": "Data link",
+    "items": "This collection items",
+    "self": "This collection",
+    "license": "License description",
+    "describedby": "Described by link",
+    "next": "Next link",
+    "previous": "Previous link",
+}
+# pylint: disable = too-few-public-methods, too-many-return-statements
 logger = Logging.default(__name__)
 P = ParamSpec("P")
 
@@ -111,6 +131,114 @@ def is_bad_request(self, request: Request, e: Exception) -> bool:
         )
 
 
+def get_link_title(link: dict, entity: dict) -> str:
+    """
+    Determine a human-readable STAC link title based on the link relation and context.
+    """
+    rel = link.get("rel")
+    href = link.get("href", "")
+    if "title" in link:
+        # don't overwrite
+        return link["title"]
+    match rel:
+        # --- special cases needing entity context ---
+        case "collection":
+            return entity.get("title") or entity.get("id") or REL_TITLES["collection"]
+        case "item":
+            return entity.get("title") or entity.get("id") or REL_TITLES["item"]
+        case "self" if entity.get("type") == "Catalog":
+            return "STAC Landing Page"
+        case "self" if href.endswith("/collections"):
+            return "All Collections"
+        case "child":
+            path = urlparse(href).path
+            collection_id = path.split("/")[-1] if path else "unknown"
+            return f"All from collection {collection_id}"
+        # --- all others: just lookup in REL_TITLES ---
+        case _:
+            return REL_TITLES.get(rel, href or "Unknown Entity")  # type: ignore
+
+
+def normalize_href(href: str) -> str:
+    """Encode query parameters in href to match expected STAC format."""
+    parsed = urlparse(href)
+    query = urlencode(parse_qsl(parsed.query), safe="")  # encode ":" -> "%3A"
+    return urlunparse(parsed._replace(query=query))
+
+
+class StacLinksTitleMiddleware(BaseHTTPMiddleware):
+    """Middleware used to update links with title"""
+
+    def __init__(self, app: FastAPI, title: str = "Default Title"):
+        """
+        Initialize the middleware.
+
+        Args:
+            app: The FastAPI application instance to attach the middleware to.
+            title: Default title to use for STAC links if no specific title is provided.
+        """
+        super().__init__(app)
+        self.title = title
+
+    async def dispatch(self, request: Request, call_next):
+        """
+        Intercept and modify outgoing responses to ensure all STAC links have proper titles.
+
+        This middleware method:
+        1. Awaits the response from the next handler.
+        2. Reads and parses the response body as JSON.
+        3. Updates the "title" property of each link using `get_link_title`.
+        4. Rebuilds the response without the original Content-Length header to prevent mismatches.
+        5. If the response body is not JSON, returns it unchanged.
+
+        Args:
+            request: The incoming FastAPI Request object.
+            call_next: The next ASGI handler in the middleware chain.
+
+        Returns:
+            A FastAPI Response object with updated STAC link titles.
+        """
+        response = await call_next(request)
+
+        body = b""
+        async for chunk in response.body_iterator:
+            body += chunk
+
+        try:
+            data = json.loads(body)
+
+            if isinstance(data, dict) and "links" in data:
+                for link in data["links"]:
+                    if isinstance(link, dict):
+                        # normalize href to decode any %xx
+                        if "href" in link:
+                            link["href"] = normalize_href(link["href"])
+                        # update title
+                        link["title"] = get_link_title(link, data)
+
+            headers = dict(response.headers)
+            headers.pop("content-length", None)
+
+            response = Response(
+                content=json.dumps(data, ensure_ascii=False).encode("utf-8"),
+                status_code=response.status_code,
+                headers=headers,
+                media_type="application/json",
+            )
+        except Exception:  # pylint: disable = broad-exception-caught
+            headers = dict(response.headers)
+            headers.pop("content-length", None)
+
+            response = Response(
+                content=body,
+                status_code=response.status_code,
+                headers=headers,
+                media_type=response.headers.get("content-type"),
+            )
+
+        return response
+
+
 def insert_middleware_at(app: FastAPI, index: int, middleware: Middleware):
     """Insert the given middleware at the specified index in a FastAPI application.
 

tests/resources/endpoints/adgs_feature.json

@@ -29,21 +29,25 @@
         {
             "rel": "collection",
             "type": "application/json",
+            "title": "S1A_OPER_MPL_ORBPRE_20210214T021411_20210221T021411_0001",
             "href": "http://testserver/auxip/collections/s2_adgs2_AUX_OBMEMC"
         },
         {
             "rel": "parent",
             "type": "application/json",
+            "title": "Parent Catalog",
             "href": "http://testserver/auxip/collections/s2_adgs2_AUX_OBMEMC"
         },
         {
             "rel": "root",
             "type": "application/json",
+            "title": "STAC Root Catalog",
             "href": "http://testserver/auxip/"
         },
         {
             "rel": "self",
             "type": "application/geo+json",
+            "title": "This collection",
             "href": "http://testserver/auxip/collections/s2_adgs2_AUX_OBMEMC/items/S1A_OPER_MPL_ORBPRE_20210214T021411_20210221T021411_0001"
         }
     ],

tests/resources/endpoints/cadip_feature.json

@@ -61,21 +61,25 @@
         {
             "rel": "collection",
             "type": "application/json",
+            "title": "S1A_20200105072204051312",
             "href": "http://testserver/cadip/collections/cadip_session_by_id"
         },
         {
             "rel": "parent",
             "type": "application/json",
+            "title": "Parent Catalog",
             "href": "http://testserver/cadip/collections/cadip_session_by_id"
         },
         {
             "rel": "root",
             "type": "application/json",
+            "title": "STAC Root Catalog",
             "href": "http://testserver/cadip/"
         },
         {
             "rel": "self",
             "type": "application/geo+json",
+            "title": "This collection",
             "href": "http://testserver/cadip/collections/cadip_session_by_id/items/S1A_20200105072204051312"
         }
     ],

tests/test_search_endpoint.py

@@ -626,7 +626,10 @@ def test_cadip_feature_collection_mapping(
         items = response.json()
         # Assert that receive odata response is correctly mapped to stac feature.
         assert items["type"] == "FeatureCollection", "Type doesn't match"
-        assert items["features"] == [cadip_feature], "Features don't match"
+        assert items["features"][0]["properties"] == cadip_feature["properties"], "properties doesn't match"
+        assert items["features"][0]["assets"] == cadip_feature["assets"], "assets doesn't match"
+        assert items["features"][0]["id"] == cadip_feature["id"], "id doesn't match"
+
         assert response.headers.get("Content-Type") == "application/geo+json"
 
     @pytest.mark.unit
@@ -651,7 +654,9 @@ def test_adgs_feature_collection_mapping(
         items = response.json()
         # Assert that receive odata response is correctly mapped to stac feature.
         assert items["type"] == "FeatureCollection", "Type doesn't match"
-        assert items["features"] == [adgs_feature], "Features don't match"
+        assert items["features"][0]["properties"] == adgs_feature["properties"], "properties doesn't match"
+        assert items["features"][0]["assets"] == adgs_feature["assets"], "assets doesn't match"
+        assert items["features"][0]["id"] == adgs_feature["id"], "id doesn't match"
         assert response.headers.get("Content-Type") == "application/geo+json"
 
     @pytest.mark.unit
@@ -1372,7 +1377,6 @@ def test_token_in_url(
             json={"value": []} if is_last else adgs_response_10_items,
             status=200,
         )
-
         response = client.get(endpoint + page)
         assert response.status_code == status.HTTP_200_OK
 
@@ -1393,6 +1397,7 @@ def test_token_in_url(
                 "type": "application/geo+json",
                 "method": "GET",
                 "href": prev_url,
+                "title": "Previous link",
             } in response.json()["links"]
         else:
             # If this is first page (1) check that "previous" link doesn't exist.
@@ -1403,6 +1408,7 @@ def test_token_in_url(
                 "type": "application/geo+json",
                 "method": "GET",
                 "href": next_url,
+                "title": "Next link",
             } in response.json()["links"]
 
             # Check that "previous" link exists
@@ -1431,6 +1437,7 @@ def setup(self, selector, cadip_response, adgs_response):
                     "rel": "self",
                     "type": "application/json",
                     "href": "http://testserver/cadip/collections/cadip_session_by_id",
+                    "title": "This collection",
                 },
             ),
             (
@@ -1443,6 +1450,7 @@ def setup(self, selector, cadip_response, adgs_response):
                     "rel": "self",
                     "type": "application/json",
                     "href": "http://testserver/auxip/collections/s2_adgs2_AUX_OBMEMC",
+                    "title": "This collection",
                 },
             ),
         ],