using new types

Author: Andrei Neagu

packages/models-library/src/models_library/api_schemas_webserver/storage.py

@@ -1,7 +1,7 @@
 from pathlib import Path
-from typing import Annotated
+from typing import Annotated, Any
 
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, BeforeValidator, Field
 
 from ..api_schemas_storage.storage_schemas import (
     DEFAULT_NUMBER_OF_PATHS_PER_PAGE,
@@ -37,5 +37,18 @@ class BatchDeletePathsBodyParams(InputSchema):
     paths: set[Path]
 
 
+def _ensure_valid_path(value: Any) -> str:
+    try:
+        Path(value)
+    except Exception as e:
+        msg = f"Provided {value=} is nto a valid path"
+        raise ValueError(msg) from e
+
+    return value
+
+
+PathToExport = Annotated[str, BeforeValidator(_ensure_valid_path)]
+
+
 class DataExportPost(InputSchema):
-    paths: list[Path]
+    paths: list[PathToExport]

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/storage/simcore_s3.py

@@ -1,11 +1,10 @@
-from pathlib import Path
-
 from models_library.api_schemas_rpc_async_jobs.async_jobs import (
     AsyncJobGet,
     AsyncJobNameData,
 )
 from models_library.api_schemas_storage import STORAGE_RPC_NAMESPACE
 from models_library.api_schemas_storage.storage_schemas import FoldersBody
+from models_library.api_schemas_webserver.storage import PathToExport
 from models_library.products import ProductName
 from models_library.rabbitmq_basic_types import RPCMethodName
 from models_library.users import UserID
@@ -38,7 +37,7 @@ async def start_data_export(
     *,
     user_id: UserID,
     product_name: ProductName,
-    paths_to_export: list[Path],
+    paths_to_export: list[PathToExport],
 ) -> tuple[AsyncJobGet, AsyncJobNameData]:
     job_id_data = AsyncJobNameData(user_id=user_id, product_name=product_name)
     async_job_rpc_get = await submit(

services/storage/src/simcore_service_storage/api/_worker_tasks/_simcore_s3.py

@@ -9,6 +9,7 @@
 from models_library.progress_bar import ProgressReport
 from models_library.projects_nodes_io import StorageFileID
 from models_library.users import UserID
+from pydantic import TypeAdapter
 from servicelib.logging_utils import log_context
 from servicelib.progress_bar import ProgressBarData
 from simcore_service_storage.exceptions.errors import FileAccessRightError
@@ -78,6 +79,11 @@ async def export_data(
         )
         assert isinstance(dsm, SimcoreS3DataManager)  # nosec
 
+        paths_to_export = [
+            TypeAdapter(StorageFileID).validate_python(path_to_export)
+            for path_to_export in paths_to_export
+        ]
+
         try:
             for path_to_export in paths_to_export:
                 await dsm.can_read_file(user_id=user_id, file_id=path_to_export)

services/web/server/tests/unit/with_dbs/01/storage/test_storage.py

@@ -464,7 +464,7 @@ async def test_data_export(
     )
 
     _body = DataExportPost(
-        paths=[Path(f"{faker.uuid4()}/{faker.uuid4()}/{faker.file_name()}")]
+        paths=[f"{faker.uuid4()}/{faker.uuid4()}/{faker.file_name()}"]
     )
     response = await client.post(
         f"/{API_VERSION}/storage/locations/0/data-export", data=_body.model_dump_json()
@@ -671,7 +671,7 @@ async def test_get_async_job_links(
     )
 
     _body = DataExportPost(
-        paths=[Path(f"{faker.uuid4()}/{faker.uuid4()}/{faker.file_name()}")]
+        paths=[f"{faker.uuid4()}/{faker.uuid4()}/{faker.file_name()}"]
     )
     response = await client.post(
         f"/{API_VERSION}/storage/locations/0/data-export", data=_body.model_dump_json()