fix REST interface in tasks plugin

Author: giancarloromeo

api/specs/web-server/_long_running_tasks.py

@@ -12,24 +12,24 @@
 from servicelib.aiohttp.long_running_tasks._routes import _PathParam
 from servicelib.long_running_tasks.models import TaskGet, TaskStatus
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.tasks._exception_handlers import _TO_HTTP_ERROR_MAP
+from simcore_service_webserver.tasks._controller._rest_exceptions import (
+    _TO_HTTP_ERROR_MAP,
+)
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
     tags=[
         "long-running-tasks",
     ],
+    responses={
+        i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values()
+    },
 )
 
-_responses: dict[int | str, dict[str, Any]] = {
-    i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values()
-}
-
 
 @router.get(
     "/tasks",
     response_model=Envelope[list[TaskGet]],
-    responses=_responses,
 )
 def list_tasks():
     """Lists all long running tasks"""
@@ -38,7 +38,6 @@ def list_tasks():
 @router.get(
     "/tasks/{task_id}",
     response_model=Envelope[TaskStatus],
-    responses=_responses,
 )
 def get_task_status(
     _path_params: Annotated[_PathParam, Depends()],
@@ -57,7 +56,6 @@ def get_task_stream(
 
 @router.delete(
     "/tasks/{task_id}",
-    responses=_responses,
     status_code=status.HTTP_204_NO_CONTENT,
 )
 def cancel_task(
@@ -69,7 +67,6 @@ def cancel_task(
 @router.get(
     "/tasks/{task_id}/result",
     response_model=Any,
-    responses=_responses,
 )
 def get_task_result(
     _path_params: Annotated[_PathParam, Depends()],

api/specs/web-server/_storage.py

@@ -4,7 +4,7 @@
 # pylint: disable=too-many-arguments
 
 
-from typing import Annotated, Any, TypeAlias
+from typing import Annotated, TypeAlias
 
 from fastapi import APIRouter, Depends, Query, status
 from models_library.api_schemas_long_running_tasks.tasks import (
@@ -35,8 +35,8 @@
 from servicelib.fastapi.rest_pagination import CustomizedPathsCursorPage
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.storage.schemas import DatasetMetaData, FileMetaData
-from simcore_service_webserver.tasks._exception_handlers import (
-    _TO_HTTP_ERROR_MAP as export_data_http_error_map,
+from simcore_service_webserver.tasks._controller._rest_exceptions import (
+    _TO_HTTP_ERROR_MAP,
 )
 
 router = APIRouter(
@@ -220,19 +220,14 @@ async def is_completed_upload_file(
     """Returns state of upload completion"""
 
 
-# data export
-_export_data_responses: dict[int | str, dict[str, Any]] = {
-    i.status_code: {"model": EnvelopedError}
-    for i in export_data_http_error_map.values()
-}
-
-
 @router.post(
     "/storage/locations/{location_id}/export-data",
     response_model=Envelope[TaskGet],
     name="export_data",
     description="Export data",
-    responses=_export_data_responses,
+    responses={
+        i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values()
+    },
 )
 async def export_data(export_data: DataExportPost, location_id: LocationID):
     """Trigger data export. Returns async job id for getting status and results"""

services/web/server/src/simcore_service_webserver/storage/_rest.py

@@ -57,7 +57,7 @@
 from ..models import AuthenticatedRequestContext, WebServerOwnerMetadata
 from ..rabbitmq import get_rabbitmq_rpc_client
 from ..security.decorators import permission_required
-from ..tasks._exception_handlers import handle_export_data_exceptions
+from ..tasks._controller._rest_exceptions import handle_export_data_exceptions
 from .schemas import StorageFileIDStr
 from .settings import StorageSettings, get_plugin_settings
 

services/web/server/src/simcore_service_webserver/tasks/_controller/__init__.py

@@ -1,7 +1,4 @@
-"""Handlers exposed by storage subsystem
-
-Mostly resolves and redirect to storage API
-"""
+"""Handlers exposed by subsystem"""
 
 import logging
 from typing import Final
@@ -31,13 +28,13 @@
 from servicelib.long_running_tasks import lrt_api
 from servicelib.rabbitmq.rpc_interfaces.async_jobs import async_jobs
 
-from .._meta import API_VTAG
-from ..login.decorators import login_required
-from ..long_running_tasks.plugin import webserver_request_context_decorator
-from ..models import AuthenticatedRequestContext, WebServerOwnerMetadata
-from ..rabbitmq import get_rabbitmq_rpc_client
-from ..security.decorators import permission_required
-from ._exception_handlers import handle_export_data_exceptions
+from ..._meta import API_VTAG
+from ...login.decorators import login_required
+from ...long_running_tasks.plugin import webserver_request_context_decorator
+from ...models import AuthenticatedRequestContext, WebServerOwnerMetadata
+from ...rabbitmq import get_rabbitmq_rpc_client
+from ...security.decorators import permission_required
+from ._rest_exceptions import handle_export_data_exceptions
 
 log = logging.getLogger(__name__)
 

services/web/server/src/simcore_service_webserver/tasks/_rest.py renamed to services/web/server/src/simcore_service_webserver/tasks/_controller/_rest.py

@@ -13,7 +13,7 @@
 )
 from servicelib.aiohttp import status
 
-from ..exception_handling import (
+from ...exception_handling import (
     ExceptionToHttpErrorMap,
     HttpErrorInfo,
     exception_handling_decorator,

services/web/server/src/simcore_service_webserver/tasks/_exception_handlers.py renamed to services/web/server/src/simcore_service_webserver/tasks/_controller/_rest_exceptions.py

@@ -1,7 +1,7 @@
 from aiohttp import web
 
 from ..rest.plugin import setup_rest
-from . import _rest
+from ._controller import _rest
 
 
 def setup_tasks(app: web.Application):