Merge remote-tracking branch 'origin/develop' into feat-rspy759/deploy-prip-stac-browser

Author: Alex Grosu

services/cadip/rs_server_cadip/api/cadip_search.py

@@ -561,7 +561,7 @@ def process_session_search(  # type: ignore # pylint: disable=too-many-arguments
     except ValueError as exception:
         logger.error(exception)
         raise HTTPException(
-            status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+            status_code=status.HTTP_422_UNPROCESSABLE_CONTENT,
             detail=str(exception),
         ) from exception
     except Exception as exception:  # pylint: disable=broad-exception-caught
@@ -611,7 +611,7 @@ def process_files_search(  # pylint: disable=too-many-locals
         queryables["SessionId"] = split_multiple_values(session_id)
 
     if limit < 1:  # type: ignore
-        raise HTTPException(status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, detail="Pagination cannot be less 0")
+        raise HTTPException(status_code=status.HTTP_422_UNPROCESSABLE_CONTENT, detail="Pagination cannot be less 0")
     # Init dataretriever / get products / return
     try:
         products = cadip_retriever.init_cadip_provider(station).search(

services/cadip/rs_server_cadip/cadip_utils.py

@@ -198,12 +198,12 @@ def cadip_map_mission(platform: str, constellation: str) -> str | None:
             )
             if satellite and satellite not in satellites:
                 raise HTTPException(
-                    status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+                    status_code=status.HTTP_422_UNPROCESSABLE_CONTENT,
                     detail="Invalid combination of platform-constellation",
                 )
     except (KeyError, IndexError, StopIteration) as exc:
         raise HTTPException(
-            status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
+            status_code=status.HTTP_422_UNPROCESSABLE_CONTENT,
             detail="Cannot map platform/constellation",
         ) from exc
     return satellite or satellites

services/catalog/rs_server_catalog/user_catalog.py

@@ -49,11 +49,11 @@
     manage_landing_page,
 )
 from rs_server_catalog.user_handler import (
+    adapt_links,
+    adapt_object_links,
     add_user_prefix,
     filter_collections,
     get_user,
-    remove_user_from_collection,
-    remove_user_from_feature,
     reroute_url,
 )
 from rs_server_catalog.utils import (
@@ -137,28 +137,6 @@ def __init__(self, client: CoreCrudClient):
         self.client = client
         self.s3_files_to_be_deleted: list[str] = []
 
-    def remove_user_from_objects(self, content: dict, user: str, object_name: str) -> dict:
-        """Remove the user id from the object.
-
-        Args:
-            content (dict): The response content from the middleware
-            'call_next' loaded in json format.
-            user (str): The user id to remove.
-            object_name (str): Precise the object type in the content.
-            It can be collections or features.
-
-        Returns:
-            dict: The content with the user id removed.
-        """
-        objects = content[object_name]
-        nb_objects = len(objects)
-        for i in range(nb_objects):
-            if object_name == "collections":
-                objects[i] = remove_user_from_collection(objects[i], user)
-            else:
-                objects[i] = remove_user_from_feature(objects[i], user)
-        return content
-
     def clear_catalog_bucket(self, content: dict):
         """Used to clear specific files from catalog bucket."""
         if not self.s3_handler:
@@ -174,47 +152,6 @@ def clear_catalog_bucket(self, content: dict):
             if not int(os.environ.get("RSPY_LOCAL_CATALOG_MODE", 0)):  # don't delete files if we are in local mode
                 self.s3_handler.delete_file_from_s3(bucket_name, file_key)
 
-    def adapt_object_links(self, my_object: dict, user: str | None) -> dict:
-        """adapt all the links from a collection so the user can use them correctly
-
-        Args:
-            object (dict): The collection
-            user (str): The user id
-
-        Returns:
-            dict: The collection passed in parameter with adapted links
-        """
-        links = my_object.get("links", [])
-        for j, link in enumerate(links):
-            link_parser = urlparse(link["href"])
-            if "properties" in my_object:  # If my_object is an item
-                new_path = add_user_prefix(link_parser.path, user, my_object["collection"], my_object["id"])
-            else:  # If my_object is a collection
-                new_path = add_user_prefix(link_parser.path, user, my_object["id"])
-            links[j]["href"] = link_parser._replace(path=new_path).geturl()
-        return my_object
-
-    def adapt_links(self, content: dict, user: str | None, collection_id: str | None, object_name: str) -> dict:
-        """adapt all the links that are outside from the collection section
-
-        Args:
-            content (dict): The response content from the middleware
-            'call_next' loaded in json format.
-            user (str): The user id.
-
-        Returns:
-            dict: The content passed in parameter with adapted links
-        """
-        links = content["links"]
-        for link in links:
-            link_parser = urlparse(link["href"])
-            new_path = add_user_prefix(link_parser.path, user, collection_id)
-            link["href"] = link_parser._replace(path=new_path).geturl()
-        # Go through each item and apply corrections to the links
-        for i in range(len(content[object_name])):
-            content[object_name][i] = self.adapt_object_links(content[object_name][i], user)
-        return content
-
     async def get_item_from_collection(self, request: Request):
         """Get an item from the collection.
 
@@ -692,10 +629,9 @@ async def manage_search_response(self, request: Request, response: StreamingResp
         body = [chunk async for chunk in response.body_iterator]
         dec_content = b"".join(map(lambda x: x if isinstance(x, bytes) else x.encode(), body)).decode()  # type: ignore
         content = json.loads(dec_content)
-        content = self.remove_user_from_objects(content, self.request_ids["owner_id"], "features")
-        content = self.adapt_links(content, None, None, "features")
+        content = adapt_links(content, "features")
         for collection_id in self.request_ids["collection_ids"]:
-            content = self.adapt_links(content, self.request_ids["owner_id"], collection_id, "features")
+            content = adapt_links(content, "features", self.request_ids["owner_id"], collection_id)
 
         # Add the stac authentication extension
         await self.add_authentication_extension(content)
@@ -1012,21 +948,18 @@ async def manage_get_response_content(  # pylint: disable=too-many-locals, too-m
         elif (
             "/collections" in request.scope["path"] and "/items" not in request.scope["path"]
         ):  # /catalog/collections/owner_id:collection_id
-            content = remove_user_from_collection(content, self.request_ids["owner_id"])
-            content = self.adapt_object_links(content, self.request_ids["owner_id"])
+            content = adapt_object_links(content, self.request_ids["owner_id"])
         elif (
             "/items" in request.scope["path"] and not self.request_ids["item_id"]
         ):  # /catalog/owner_id/collections/collection_id/items
-            content = self.remove_user_from_objects(content, self.request_ids["owner_id"], "features")
-            content = self.adapt_links(
+            content = adapt_links(
                 content,
+                "features",
                 self.request_ids["owner_id"],
                 self.request_ids["collection_ids"][0],
-                "features",
             )
         elif self.request_ids["item_id"]:  # /catalog/owner_id/collections/collection_id/items/item_id
-            content = remove_user_from_feature(content, self.request_ids["owner_id"])
-            content = self.adapt_object_links(content, self.request_ids["owner_id"])
+            content = adapt_object_links(content, self.request_ids["owner_id"])
         else:
             logger.debug(f"No link adaptation performed for {request.scope}")
 
@@ -1102,15 +1035,13 @@ async def manage_put_post_response(self, request: Request, response: StreamingRe
             response_content = json.loads(b"".join(body).decode())  # type: ignore
             # Don't display geometry and bbox for default case since it was added just for compliance.
             if request.scope["path"] == CATALOG_COLLECTIONS:
-                response_content = remove_user_from_collection(response_content, user)
-                response_content = self.adapt_object_links(response_content, user)
+                response_content = adapt_object_links(response_content, self.request_ids["owner_id"])
             elif (
                 request.scope["path"]
                 == CATALOG_COLLECTIONS
                 + f"/{user}_{self.request_ids['collection_ids'][0]}/items/{self.request_ids['item_id']}"
             ):
-                response_content = remove_user_from_feature(response_content, user)
-                response_content = self.adapt_object_links(response_content, user)
+                response_content = adapt_object_links(response_content, self.request_ids["owner_id"])
                 if response_content.get("geometry") == DEFAULT_GEOM:
                     response_content["geometry"] = None
                 if response_content.get("bbox") == DEFAULT_BBOX:

services/catalog/rs_server_catalog/user_handler.py

@@ -18,6 +18,7 @@
 import os
 import re
 from typing import Any
+from urllib.parse import urlparse
 
 from rs_server_common.authentication.oauth2 import AUTH_PREFIX
 from rs_server_common.utils.logging import Logging
@@ -227,40 +228,62 @@ def add_user_prefix(  # pylint: disable=too-many-return-statements
     return new_path
 
 
-def remove_user_from_feature(feature: dict, user: str) -> dict:
-    """Remove the user ID from the collection name in the feature.
+def remove_owner_from_collection_name_in_feature(feature: dict, current_user: str = "") -> tuple[dict, str]:
+    """Remove the owner name from the collection name in the feature.
+    The owner name used is the "owner" field of the properties if there is any,
+    or by default the currently connected user.
+    Returns the updated feature and the owner name actually removed.
+    If nothing was removed, returns the original feature and an empty owner name.
 
     Args:
         feature (dict): a geojson that contains georeferenced
-        data and metadata like the collection name.
-        user (str): The user ID.
+            data and metadata like the collection name.
+        current_user (str): current user connected (optional)
 
     Returns:
-        dict: the feature with a new collection name without the user ID.
+        dict: the feature with a new collection name without the owner name.
+        str: the name removed, if any.
     """
-    if user in feature["collection"]:
+    if "owner" in feature["properties"]:
+        user = feature["properties"]["owner"]
+    else:
+        user = current_user
+
+    if feature["collection"].startswith(f"{user}_"):
         feature["collection"] = feature["collection"].removeprefix(f"{user}_")
-    return feature
+        return feature, user
+    return feature, ""
 
 
-def remove_user_from_collection(collection: dict, user: str) -> dict:
-    """Remove the user ID from the id section in the collection.
+def remove_owner_from_collection_name_in_collection(collection: dict, current_user: str = "") -> tuple[dict, str]:
+    """Remove the owner name from the given collection name.
+    The owner name used is the "owner" field of the collection if there is any,
+    or by default the currently connected user.
+    Returns the updated collection and the owner name actually removed.
+    If nothing was removed, returns the original collection and an empty owner name.
 
     Args:
         collection (dict): A dictionary that contains metadata
-        about the collection content like the id of the collection.
-        user (str): The user ID.
+            about the collection content like the id of the collection.
+        current_user (str): current user connected (optional)
 
     Returns:
-        dict: The collection without the user ID in the id section.
+        dict: The collection without the owner name in the id section.
+        str: the name removed, if any.
     """
-    if user and (user in collection.get("id", "")):
+    if "owner" in collection:
+        user = collection["owner"]
+    else:
+        user = current_user
+
+    if collection["id"].startswith(f"{user}_"):
         collection["id"] = collection["id"].removeprefix(f"{user}_")
-    return collection
+        return collection, user
+    return collection, ""
 
 
 def filter_collections(collections: list[dict], prefix: str) -> list[dict]:
-    """filter the collections according to the prefix.
+    """Filter the collections according to the prefix.
 
     Args:
         collections (list[dict]): The list of collections available.
@@ -270,3 +293,64 @@ def filter_collections(collections: list[dict], prefix: str) -> list[dict]:
         list[dict]: The list of collections corresponding to the prefix
     """
     return [collection for collection in collections if collection["id"].startswith(prefix)]
+
+
+def adapt_object_links(object_content: dict, current_user: str = "") -> dict:
+    """Adapt all the links from a collection using the user and collection name they already contain,
+    so the user can access them correctly
+
+    Args:
+        object (dict): The collection
+
+    Returns:
+        dict: The collection passed in parameter with adapted links
+    """
+    user = collection_id = feature_id = ""
+
+    # Case when object is an item
+    if "properties" in object_content and "collection" in object_content:
+        object_content, user = remove_owner_from_collection_name_in_feature(object_content, current_user)
+        collection_id = object_content["collection"]
+        feature_id = object_content["id"]
+
+    # Case when object is a collection
+    elif "id" in object_content:
+        object_content, user = remove_owner_from_collection_name_in_collection(object_content, current_user)
+        collection_id = object_content["id"]
+
+    # Update links with user, collection and feature values retrieved from previous steps
+    links = object_content.get("links", [])
+    for j, link in enumerate(links):
+        link_parser = urlparse(link["href"])
+        new_path = add_user_prefix(link_parser.path, user, collection_id, feature_id)
+        links[j]["href"] = link_parser._replace(path=new_path).geturl()
+
+    return object_content
+
+
+def adapt_links(content: dict, object_name: str, current_user: str = "", current_collection_id: str = "") -> dict:
+    """Adapt all the links that are outside from the collection section with the given user and collection name,
+    then the ones inside with the user and collection names they already contain.
+
+    Args:
+        content (dict): The response content from the middleware
+        'call_next' loaded in json format.
+        current_user (str): The user id that is currently connected.
+        current_collection (str): The current collection name.
+        object_name (str): Type of object we want to also update.
+
+    Returns:
+        dict: The content passed in parameter with adapted links
+    """
+    # Adapt links outside of objects with current user/collection situation
+    links = content["links"]
+    for link in links:
+        link_parser = urlparse(link["href"])
+        new_path = add_user_prefix(link_parser.path, current_user, current_collection_id)
+        link["href"] = link_parser._replace(path=new_path).geturl()
+
+    # Go through each object and apply corrections to the links using the object's info
+    for i in range(len(content[object_name])):
+        content[object_name][i] = adapt_object_links(content[object_name][i], current_user)
+
+    return content

services/catalog/tests/test_authentication_catalog.py

@@ -42,7 +42,7 @@
     HTTP_401_UNAUTHORIZED,
     HTTP_403_FORBIDDEN,
     HTTP_404_NOT_FOUND,
-    HTTP_422_UNPROCESSABLE_ENTITY,
+    HTTP_422_UNPROCESSABLE_CONTENT,
     HTTP_500_INTERNAL_SERVER_ERROR,
 )
 
@@ -1572,7 +1572,7 @@ async def test_error_when_not_authenticated(mocker, client, httpx_mock: HTTPXMoc
                 assert response.status_code not in (
                     HTTP_401_UNAUTHORIZED,
                     HTTP_403_FORBIDDEN,
-                    HTTP_422_UNPROCESSABLE_ENTITY,  # with 422, the authentication is not called and not tested
+                    HTTP_422_UNPROCESSABLE_CONTENT,  # with 422, the authentication is not called and not tested
                 )
 
                 # With a wrong apikey, we should have a 403 error

services/catalog/tests/test_endpoints/test_catalog_publish_collection_endpoint.py

@@ -248,14 +248,18 @@ def test_update_more_than_a_collection(self, client):
         assert response_content["code"] == "BadRequest"
         assert response_content["description"] == "Cannot create or update more than one collection !"
 
-    @patch("rs_server_catalog.user_catalog.remove_user_from_collection")
-    def test_failure_to_create_collection_generic_exception(self, mock_remove_user_from_collection, client):
+    @patch("rs_server_catalog.user_handler.remove_owner_from_collection_name_in_collection")
+    def test_failure_to_create_collection_generic_exception(
+        self,
+        mock_remove_owner_from_collection_name_in_collection,
+        client,
+    ):
         """
         Test endpoint POST /catalog/collections with an generic exception raised.
         Endpoint: POST /catalog/collections
         """
         mock_exc = "ValueError"
-        mock_remove_user_from_collection.side_effect = ValueError(mock_exc)
+        mock_remove_owner_from_collection_name_in_collection.side_effect = ValueError(mock_exc)
 
         minimal_collection = {
             "id": "test_collection_01",
@@ -277,14 +281,18 @@ def test_failure_to_create_collection_generic_exception(self, mock_remove_user_f
         assert response_content["code"] == "BadRequest"
         assert response_content["description"] == f"Bad request: {mock_exc}"
 
-    @patch("rs_server_catalog.user_catalog.remove_user_from_collection")
-    def test_failure_to_create_collection_runtime_error(self, mock_remove_user_from_collection, client):
+    @patch("rs_server_catalog.user_handler.remove_owner_from_collection_name_in_collection")
+    def test_failure_to_create_collection_runtime_error(
+        self,
+        mock_remove_owner_from_collection_name_in_collection,
+        client,
+    ):
         """
         Test endpoint POST /catalog/collections with an RuntimeError exception raised.
         Endpoint: POST /catalog/collections
         """
         mock_exc = "RuntimeError"
-        mock_remove_user_from_collection.side_effect = RuntimeError(mock_exc)
+        mock_remove_owner_from_collection_name_in_collection.side_effect = RuntimeError(mock_exc)
 
         minimal_collection = {
             "id": "test_collection_02",