refactor: rename ComputationsApi to DirectorV2RestClient and update method names for clarity

Author: pcrespov

services/web/server/src/simcore_service_webserver/director_v2/_client.py

@@ -42,12 +42,12 @@ async def is_healthy(app: web.Application) -> bool:
         return False
 
 
-class ComputationsApi:
+class DirectorV2RestClient:
     def __init__(self, app: web.Application) -> None:
         self._app = app
         self._settings: DirectorV2Settings = get_plugin_settings(app)
 
-    async def get(
+    async def get_computation(
         self, project_id: ProjectID, user_id: UserID
     ) -> DirectorV2ComputationGet:
         computation_task_out = await request_director_v2(
@@ -61,7 +61,7 @@ async def get(
         assert isinstance(computation_task_out, dict)  # nosec
         return DirectorV2ComputationGet.model_validate(computation_task_out)
 
-    async def start(
+    async def start_computation(
         self, project_id: ProjectID, user_id: UserID, product_name: str, **options
     ) -> str:
         computation_task_out = await request_director_v2(
@@ -80,7 +80,7 @@ async def start(
         computation_task_out_id: str = computation_task_out["id"]
         return computation_task_out_id
 
-    async def stop(self, project_id: ProjectID, user_id: UserID):
+    async def stop_computation(self, project_id: ProjectID, user_id: UserID):
         await request_director_v2(
             self._app,
             "POST",
@@ -90,13 +90,13 @@ async def stop(self, project_id: ProjectID, user_id: UserID):
         )
 
 
-_APP_KEY = f"{__name__}.{ComputationsApi.__name__}"
+_APP_KEY = f"{__name__}.{DirectorV2RestClient.__name__}"
 
 
-def get_client(app: web.Application) -> ComputationsApi | None:
-    app_key: ComputationsApi | None = app.get(_APP_KEY)
+def get_client(app: web.Application) -> DirectorV2RestClient | None:
+    app_key: DirectorV2RestClient | None = app.get(_APP_KEY)
     return app_key
 
 
-def set_client(app: web.Application, obj: ComputationsApi):
+def set_client(app: web.Application, obj: DirectorV2RestClient):
     app[_APP_KEY] = obj

services/web/server/src/simcore_service_webserver/director_v2/_controller/rest.py

@@ -27,7 +27,8 @@
 from ...products import products_web
 from ...security.decorators import permission_required
 from ...utils_aiohttp import envelope_json_response
-from .. import _client, _service
+from .. import _service
+from .._client import DirectorV2RestClient
 from .._service_abc import CommitID, get_project_run_policy
 from ._rest_exceptions import handle_rest_requests_exceptions
 
@@ -106,10 +107,12 @@ async def start_computation(request: web.Request) -> web.Response:
         else True
     )
 
-    computations = _client.ComputationsApi(request.app)
+    computations = DirectorV2RestClient(request.app)
     _started_pipelines_ids = await asyncio.gather(
         *[
-            computations.start(pid, req_ctx.user_id, req_ctx.product_name, **options)
+            computations.start_computation(
+                pid, req_ctx.user_id, req_ctx.product_name, **options
+            )
             for pid in running_project_ids
         ]
     )
@@ -134,7 +137,7 @@ async def start_computation(request: web.Request) -> web.Response:
 @handle_rest_requests_exceptions
 async def stop_computation(request: web.Request) -> web.Response:
     req_ctx = RequestContext.model_validate(request)
-    computations = _client.ComputationsApi(request.app)
+    computations = DirectorV2RestClient(request.app)
     run_policy = get_project_run_policy(request.app)
     assert run_policy  # nosec
 
@@ -148,7 +151,7 @@ async def stop_computation(request: web.Request) -> web.Response:
     )
 
     await asyncio.gather(
-        *[computations.stop(pid, req_ctx.user_id) for pid in project_ids]
+        *[computations.stop_computation(pid, req_ctx.user_id) for pid in project_ids]
     )
     return web.json_response(status=status.HTTP_204_NO_CONTENT)
 
@@ -159,7 +162,7 @@ async def stop_computation(request: web.Request) -> web.Response:
 @permission_required("project.read")
 @handle_rest_requests_exceptions
 async def get_computation(request: web.Request) -> web.Response:
-    computations = _client.ComputationsApi(request.app)
+    computations = DirectorV2RestClient(request.app)
     run_policy = get_project_run_policy(request.app)
     assert run_policy  # nosec
 
@@ -175,7 +178,10 @@ async def get_computation(request: web.Request) -> web.Response:
     )
 
     list_computation_tasks = await asyncio.gather(
-        *[computations.get(project_id=pid, user_id=user_id) for pid in project_ids]
+        *[
+            computations.get_computation(project_id=pid, user_id=user_id)
+            for pid in project_ids
+        ]
     )
 
     assert len(list_computation_tasks) == len(project_ids)  # nosec

services/web/server/src/simcore_service_webserver/director_v2/plugin.py

@@ -27,7 +27,7 @@ def setup_director_v2(app: web.Application):
     assert app[APP_SETTINGS_KEY].WEBSERVER_DIRECTOR_V2  # nosec
 
     # client to communicate with director-v2 service
-    _client.set_client(app, _client.ComputationsApi(app))
+    _client.set_client(app, _client.DirectorV2RestClient(app))
 
     # routes at the web-server app
     setup_rest(app)