locations

Author: sanderegg

services/storage/src/simcore_service_storage/api/rest/_locations.py

@@ -1,28 +1,23 @@
 import asyncio
 import logging
-from typing import cast
+from typing import Annotated, cast
 
-from aiohttp import web
-from aiohttp.web import RouteTableDef
-from common_library.json_serialization import json_dumps
+from fastapi import APIRouter, Depends, HTTPException, Request
 from models_library.api_schemas_storage import FileLocation
+from models_library.generics import Envelope
 from models_library.projects_nodes_io import StorageFileID
+from servicelib.aiohttp import status
 from servicelib.aiohttp.application_keys import (
     APP_CONFIG_KEY,
     APP_FIRE_AND_FORGET_TASKS_KEY,
 )
-from servicelib.aiohttp.requests_validation import (
-    parse_request_path_parameters_as,
-    parse_request_query_parameters_as,
-)
 from servicelib.utils import fire_and_forget_task
 
 # Exclusive for simcore-s3 storage -----------------------
-from ..._meta import API_VTAG
 from ...core.settings import ApplicationSettings
 from ...dsm import get_dsm_provider
 from ...models import (
-    LocationPathParams,
+    LocationID,
     StorageQueryParamsBase,
     SyncMetadataQueryParams,
     SyncMetadataResponse,
@@ -31,43 +26,43 @@
 
 _logger = logging.getLogger(__name__)
 
-routes = RouteTableDef()
+router = APIRouter(
+    tags=["locations"],
+)
 
 
 # HANDLERS ---------------------------------------------------
-@routes.get(f"/{API_VTAG}/locations", name="list_storage_locations")
-async def list_storage_locations(request: web.Request) -> web.Response:
-    query_params: StorageQueryParamsBase = parse_request_query_parameters_as(
-        StorageQueryParamsBase, request
-    )
-    _logger.debug(
-        "received call to list_storage_locations with %s",
-        f"{query_params=}",
-    )
+@router.get(
+    "/locations",
+    status_code=status.HTTP_200_OK,
+    response_model=Envelope[list[FileLocation]],
+)
+async def list_storage_locations(
+    query_params: Annotated[StorageQueryParamsBase, Depends()], request: Request
+):
     dsm_provider = get_dsm_provider(request.app)
     location_ids = dsm_provider.locations()
     locs: list[FileLocation] = []
     for loc_id in location_ids:
         dsm = dsm_provider.get(loc_id)
         if await dsm.authorized(query_params.user_id):
             locs.append(FileLocation(name=dsm.location_name, id=dsm.location_id))
-
-    return web.json_response({"error": None, "data": locs}, dumps=json_dumps)
+    return Envelope[list[FileLocation]](data=locs)
 
 
-@routes.post(
-    f"/{API_VTAG}/locations/{{location_id}}:sync", name="synchronise_meta_data_table"
+@router.post(
+    "/locations/{location_id}:sync", response_model=Envelope[SyncMetadataResponse]
 )
-async def synchronise_meta_data_table(request: web.Request) -> web.Response:
-    query_params: SyncMetadataQueryParams = parse_request_query_parameters_as(
-        SyncMetadataQueryParams, request
-    )
-    path_params = parse_request_path_parameters_as(LocationPathParams, request)
-    _logger.debug(
-        "received call to synchronise_meta_data_table with %s",
-        f"{path_params=}, {query_params=}",
-    )
-
+async def synchronise_meta_data_table(
+    query_params: Annotated[SyncMetadataQueryParams, Depends()],
+    location_id: LocationID,
+    request: Request,
+):
+    if not location_id == SimcoreS3DataManager.get_location_id():
+        raise HTTPException(
+            status.HTTP_400_BAD_REQUEST,
+            detail="invalid call: cannot be called for other than simcore",
+        )
     dsm = cast(
         SimcoreS3DataManager,
         get_dsm_provider(request.app).get(SimcoreS3DataManager.get_location_id()),
@@ -101,10 +96,4 @@ async def _go():
         fire_and_forget=query_params.fire_and_forget,
         dry_run=query_params.dry_run,
     )
-    return web.json_response(
-        {
-            "error": None,
-            "data": response,
-        },
-        dumps=json_dumps,
-    )
+    return Envelope[SyncMetadataResponse](data=response)