🐛 Improve error message clarity in get_task_result and change create_project return type to HTTPCreated

Author: pcrespov

packages/service-library/src/servicelib/aiohttp/rest_middlewares.py

@@ -12,7 +12,7 @@
 from aiohttp.web_request import Request
 from aiohttp.web_response import StreamResponse
 from common_library.error_codes import ErrorCodeStr, create_error_code
-from common_library.json_serialization import json_dumps, json_loads
+from common_library.json_serialization import json_dumps
 from common_library.user_messages import user_message
 from models_library.basic_types import IDStr
 from models_library.rest_error import ErrorGet, ErrorItemType, LogMessageType
@@ -21,7 +21,7 @@
 
 from ..logging_errors import create_troubleshootting_log_kwargs
 from ..mimetype_constants import MIMETYPE_APPLICATION_JSON
-from ..rest_responses import is_enveloped_from_map, is_enveloped_from_text
+from ..rest_responses import is_enveloped_from_text
 from ..status_codes_utils import get_code_description
 from . import status
 from .rest_responses import (
@@ -167,11 +167,9 @@ def _handle_http_successful(
             exception.status, safe_status_message(message=exception.reason)
         )
 
-    if exception.text:
-        payload = json_loads(exception.text)
-        if not is_enveloped_from_map(payload):
-            payload = wrap_as_envelope(data=payload)
-            exception.text = json_dumps(payload)
+    if exception.text and not is_enveloped_from_text(exception.text):
+        payload = wrap_as_envelope(data=exception.text)
+        exception.text = json_dumps(payload)
 
     return exception
 

packages/service-library/src/servicelib/long_running_tasks/http_endpoint_responses.py

@@ -44,7 +44,7 @@ async def get_task_result(
     except Exception as exc:
         _logger.exception(
             **create_troubleshootting_log_kwargs(
-                user_error_msg=f"{task_id=} raised an exception",
+                user_error_msg=f"{task_id=} raised an exception while getting its result",
                 error=exc,
                 error_code=create_error_code(exc),
                 error_context={"task_context": task_context, "task_id": task_id},

services/web/server/src/simcore_service_webserver/projects/_crud_api_create.py

@@ -263,7 +263,7 @@ async def create_project(  # pylint: disable=too-many-arguments,too-many-branche
     simcore_user_agent: str,
     parent_project_uuid: ProjectID | None,
     parent_node_id: NodeID | None,
-) -> None:
+) -> web.HTTPCreated:
     """Implements TaskProtocol for 'create_projects' handler
 
     Arguments:
@@ -278,7 +278,6 @@ async def create_project(  # pylint: disable=too-many-arguments,too-many-branche
         predefined_project -- project in request body
 
     Raises:
-        web.HTTPCreated: succeeded
         web.HTTPBadRequest:
         web.HTTPNotFound:
         web.HTTPUnauthorized:
@@ -481,7 +480,7 @@ async def create_project(  # pylint: disable=too-many-arguments,too-many-branche
             **RESPONSE_MODEL_POLICY
         )
 
-        raise web.HTTPCreated(
+        return web.HTTPCreated(
             text=json_dumps({"data": data}),
             content_type=MIMETYPE_APPLICATION_JSON,
         )