🐛 Fix error handling to ensure proper JSON response structure and add tests for raw text responses

Author: pcrespov

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

@@ -67,7 +67,7 @@ def handle_validation_as_http_error(
                 }
                 for e in details
             ]
-            error_str = json_dumps(
+            error_json_str = json_dumps(
                 {
                     "error": {
                         "status": status.HTTP_422_UNPROCESSABLE_ENTITY,
@@ -77,7 +77,7 @@ def handle_validation_as_http_error(
             )
         else:
             # NEW proposed error for https://github.com/ITISFoundation/osparc-simcore/issues/443
-            error_str = json_dumps(
+            error_json_str = json_dumps(
                 {
                     "error": {
                         "msg": user_error_message,
@@ -88,7 +88,7 @@ def handle_validation_as_http_error(
             )
 
         raise web.HTTPUnprocessableEntity(  # 422
-            text=error_str,
+            text=error_json_str,
             content_type=MIMETYPE_APPLICATION_JSON,
         ) from err
 

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
+from common_library.json_serialization import json_dumps, json_loads
 from common_library.user_messages import user_message
 from models_library.basic_types import IDStr
 from models_library.rest_error import ErrorGet, ErrorItemType, LogMessageType
@@ -168,8 +168,9 @@ def _handle_http_successful(
         )
 
     if exception.text and not is_enveloped_from_text(exception.text):
-        payload = wrap_as_envelope(data=exception.text)
-        exception.text = json_dumps(payload)
+        # Ensures that the response is enveloped
+        data = json_loads(exception.text)
+        exception.text = json_dumps({"data": data})
 
     return exception
 

packages/service-library/tests/aiohttp/test_rest_middlewares.py

@@ -128,6 +128,10 @@ async def raise_success_with_text(_request: web.Request):
         # NOTE: explicitly NOT enveloped!
         raise web.HTTPOk(reason="I'm ok", text=json.dumps({"ok": True}))
 
+    @staticmethod
+    async def raise_success_with_raw_text(_request: web.Request):
+        raise web.HTTPOk(text="I'm ok")  # NOT ALLOWED!
+
 
 @pytest.fixture
 async def client(
@@ -158,6 +162,10 @@ async def client(
                 ("/v1/raise_success", Handlers.raise_success),
                 ("/v1/raise_success_with_reason", Handlers.raise_success_with_reason),
                 ("/v1/raise_success_with_text", Handlers.raise_success_with_text),
+                (
+                    "/v1/raise_success_with_raw_text",
+                    Handlers.raise_success_with_raw_text,
+                ),
             ]
         ]
     )
@@ -330,6 +338,7 @@ async def test_http_ok_with_text_is_enveloped(client: TestClient):
     """Test that HTTPOk with text is properly enveloped."""
     response = await client.get("/v1/raise_success_with_text")
     assert response.status == status.HTTP_200_OK
+    assert response.reason == "I'm ok"
 
     # Should be enveloped
     payload = await response.json()
@@ -342,6 +351,11 @@ async def test_http_ok_with_text_is_enveloped(client: TestClient):
     assert data.get("ok") is True
 
 
+async def test_http_ok_with_raw_text_is_not_allowed(client: TestClient):
+    response = await client.get("/v1/raise_success_with_raw_text")
+    assert response.status == status.HTTP_500_INTERNAL_SERVER_ERROR
+
+
 async def test_exception_in_handler_returns_500(
     client: TestClient, mocker: MockerFixture
 ):

services/web/server/src/simcore_service_webserver/activity/_handlers.py

@@ -6,7 +6,6 @@
 from models_library.api_schemas_webserver.activity import ActivityStatusDict
 from pydantic import TypeAdapter
 from servicelib.aiohttp.client_session import get_client_session
-from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
 from servicelib.request_keys import RQT_USERID_KEY
 from yarl import URL