refactor

Author: sanderegg

api/specs/storage/openapi.py

@@ -126,10 +126,10 @@ async def get_files_metadata_dataset(
     f"/{API_VTAG}/locations",
     response_model=list[DatasetMetaData],
     tags=TAGS_LOCATIONS,
-    operation_id="get_storage_locations",
+    operation_id="list_storage_locations",
     summary="Get available storage locations",
 )
-async def get_storage_locations(user_id: UserID):
+async def list_storage_locations(user_id: UserID):
     """Returns the list of available storage locations"""
 
 

api/specs/web-server/_storage.py

@@ -41,7 +41,7 @@
     response_model=list[DatasetMetaData],
     summary="Get available storage locations",
 )
-async def get_storage_locations():
+async def list_storage_locations():
     """Returns the list of available storage locations"""
 
 

packages/simcore-sdk/src/simcore_sdk/node_ports_common/_filemanager.py

@@ -34,7 +34,7 @@ async def _get_location_id_from_location_name(
     store: LocationName,
     session: ClientSession,
 ) -> LocationID:
-    resp = await storage_client.get_storage_locations(session=session, user_id=user_id)
+    resp = await storage_client.list_storage_locations(session=session, user_id=user_id)
     for location in resp:
         if location.name == store:
             return cast(LocationID, location.id)  # mypy wants it

packages/simcore-sdk/src/simcore_sdk/node_ports_common/storage_client.py

@@ -46,7 +46,7 @@
 
 
 def handle_client_exception(
-    handler: Callable[P, Coroutine[Any, Any, R]]
+    handler: Callable[P, Coroutine[Any, Any, R]],
 ) -> Callable[P, Coroutine[Any, Any, R]]:
     @wraps(handler)
     async def wrapped(*args: P.args, **kwargs: P.kwargs) -> R:
@@ -134,7 +134,7 @@ async def retry_request(
 
 
 @handle_client_exception
-async def get_storage_locations(
+async def list_storage_locations(
     *, session: ClientSession, user_id: UserID
 ) -> FileLocationArray:
     async with retry_request(
@@ -239,7 +239,6 @@ async def get_file_metadata(
         expected_status=status.HTTP_200_OK,
         params={"user_id": f"{user_id}"},
     ) as response:
-
         payload = await response.json()
         if not payload.get("data"):
             # NOTE: keeps backwards compatibility

packages/simcore-sdk/tests/unit/test_storage_client.py

@@ -30,9 +30,9 @@
     delete_file,
     get_download_file_link,
     get_file_metadata,
-    get_storage_locations,
     get_upload_file_links,
     list_file_metadata,
+    list_storage_locations,
 )
 from simcore_sdk.node_ports_common.storage_endpoint import (
     get_base_url,
@@ -92,14 +92,14 @@ async def session() -> AsyncIterator[aiohttp.ClientSession]:
         yield session
 
 
-async def test_get_storage_locations(
+async def test_list_storage_locations(
     clear_caches: None,
     storage_v0_service_mock: AioResponsesMock,
     mock_postgres: EnvVarsDict,
     session: aiohttp.ClientSession,
     user_id: UserID,
 ):
-    result = await get_storage_locations(session=session, user_id=user_id)
+    result = await list_storage_locations(session=session, user_id=user_id)
     assert isinstance(result, FileLocationArray)  # type: ignore
 
     assert len(result) == 1

services/director-v2/tests/unit/with_dbs/comp_scheduler/test_api_route_computations_tasks.py

@@ -92,8 +92,8 @@ class Loc(NamedTuple):
             autospec=True,
             return_value=faker.url(),
         ),
-        "get_storage_locations": mocker.patch(
-            "simcore_sdk.node_ports_common.storage_client.get_storage_locations",
+        "list_storage_locations": mocker.patch(
+            "simcore_sdk.node_ports_common.storage_client.list_storage_locations",
             autospec=True,
             return_value=[
                 Loc(name="simcore.s3", id=0),
@@ -159,7 +159,7 @@ async def test_get_all_tasks_log_files(
     )
 
     # calls storage
-    mocked_nodeports_storage_client["get_storage_locations"].assert_not_called()
+    mocked_nodeports_storage_client["list_storage_locations"].assert_not_called()
     assert mocked_nodeports_storage_client["get_download_file_link"].called
 
     # test expected response according to OAS!
@@ -207,7 +207,6 @@ async def test_get_tasks_outputs(
 
 
 async def test_get_tasks_outputs_not_found(node_id: NodeID, client: httpx.AsyncClient):
-
     invalid_project = uuid4()
     resp = await client.post(
         f"/v2/computations/{invalid_project}/tasks/-/outputs:batchGet",

services/storage/src/simcore_service_storage/api/v0/openapi.yaml

@@ -101,7 +101,7 @@ paths:
       - locations
       summary: Get available storage locations
       description: Returns the list of available storage locations
-      operationId: get_storage_locations
+      operationId: list_storage_locations
       parameters:
       - name: user_id
         in: query

services/storage/src/simcore_service_storage/handlers_locations.py

@@ -30,13 +30,13 @@
 
 
 # HANDLERS ---------------------------------------------------
-@routes.get(f"/{API_VTAG}/locations", name="get_storage_locations")
-async def get_storage_locations(request: web.Request) -> web.Response:
+@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
     )
     log.debug(
-        "received call to get_storage_locations with %s",
+        "received call to list_storage_locations with %s",
         f"{query_params=}",
     )
     dsm_provider = get_dsm_provider(request.app)

services/storage/tests/unit/test__legacy_storage_sdk_compatibility.py

@@ -101,7 +101,7 @@ async def test_storage_client_used_in_simcore_sdk_0_3_2(  # noqa: PLR0915
             response_payload,
             status_code,
             response_headers,
-        ) = await api.get_storage_locations_with_http_info(user_id)
+        ) = await api.list_storage_locations_with_http_info(user_id)
         print(f"{response_payload=}")
         print(f"{status_code=}")
         print(f"{response_headers=}")
@@ -145,7 +145,7 @@ async def test_storage_client_used_in_simcore_sdk_0_3_2(  # noqa: PLR0915
 
         # _get_location_id_from_location_name
         # https://github.com/ITISFoundation/osparc-simcore/blob/cfdf4f86d844ebb362f4f39e9c6571d561b72897/packages/simcore-sdk/src/simcore_sdk/node_ports/filemanager.py#L89
-        resp_model = await api.get_storage_locations(user_id=user_id)
+        resp_model = await api.list_storage_locations(user_id=user_id)
         print(f"{resp_model=}")
         for location in resp_model.data:
             assert location["name"] == location_name

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -5666,7 +5666,7 @@ paths:
       - storage
       summary: Get available storage locations
       description: Returns the list of available storage locations
-      operationId: get_storage_locations
+      operationId: list_storage_locations
       responses:
         '200':
           description: Successful Response