🐛 Update HTTP error handling to use 'text' instead of 'reason' for consistent response formatting

Author: pcrespov

services/web/server/src/simcore_service_webserver/catalog/_catalog_rest_client_service.py

@@ -39,7 +39,7 @@ def _handle_client_exceptions(app: web.Application) -> Iterator[ClientSession]:
 
     except ClientResponseError as err:
         if err.status == status.HTTP_404_NOT_FOUND:
-            raise web.HTTPNotFound(reason=MSG_CATALOG_SERVICE_NOT_FOUND)
+            raise web.HTTPNotFound(text=MSG_CATALOG_SERVICE_NOT_FOUND) from err
         raise web.HTTPServiceUnavailable(
             reason=MSG_CATALOG_SERVICE_UNAVAILABLE
         ) from err

services/web/server/src/simcore_service_webserver/login/_controller/rest/change.py

@@ -216,7 +216,7 @@ def _get_error_context(
                     error_context=_get_error_context(user),
                 )
             )
-            raise web.HTTPServiceUnavailable(reason=MSG_CANT_SEND_MAIL) from err
+            raise web.HTTPServiceUnavailable(text=MSG_CANT_SEND_MAIL) from err
 
     # NOTE: Always same response: guideline #1
     return flash_response(MSG_EMAIL_SENT.format(email=request_body.email), "INFO")
@@ -241,7 +241,7 @@ async def initiate_change_email(request: web.Request):
 
     async with pass_or_acquire_connection(get_asyncpg_engine(request.app)) as conn:
         if await UsersRepo.is_email_used(conn, email=request_body.email):
-            raise web.HTTPUnprocessableEntity(reason="This email cannot be used")
+            raise web.HTTPUnprocessableEntity(text="This email cannot be used")
 
     # Reset if previously requested
     confirmation = await db.get_confirmation({"user": user, "action": CHANGE_EMAIL})
@@ -268,7 +268,7 @@ async def initiate_change_email(request: web.Request):
     except Exception as err:  # pylint: disable=broad-except
         _logger.exception("Can not send change_email_email")
         await db.delete_confirmation(confirmation)
-        raise web.HTTPServiceUnavailable(reason=MSG_CANT_SEND_MAIL) from err
+        raise web.HTTPServiceUnavailable(text=MSG_CANT_SEND_MAIL) from err
 
     return flash_response(MSG_CHANGE_EMAIL_REQUESTED)
 

services/web/server/src/simcore_service_webserver/login/_controller/rest/registration.py

@@ -301,7 +301,7 @@ async def register(request: web.Request):
 
             await db.delete_confirmation_and_user(user, _confirmation)
 
-            raise web.HTTPServiceUnavailable(reason=user_error_msg) from err
+            raise web.HTTPServiceUnavailable(text=user_error_msg) from err
 
         return flash_response(
             "You are registered successfully! To activate your account, please, "

services/web/server/src/simcore_service_webserver/projects/_controller/nodes_rest.py

@@ -305,7 +305,7 @@ async def _stop_dynamic_service_task(
 
     except (RPCServerError, ServiceWaitingForManualInterventionError) as exc:
         # in case there is an error reply as not found
-        raise web.HTTPNotFound(reason=f"{exc}") from exc
+        raise web.HTTPNotFound(text=f"{exc}") from exc
 
     except ServiceWasNotFoundError:
         # in case the service is not found reply as all OK

services/web/server/src/simcore_service_webserver/projects/_controller/ports_rest.py

@@ -101,7 +101,7 @@ async def update_project_inputs(request: web.Request) -> web.Response:
     for input_update in inputs_updates:
         node_id = input_update.key
         if node_id not in current_inputs:
-            raise web.HTTPBadRequest(reason=f"Invalid input key [{node_id}]")
+            raise web.HTTPBadRequest(text=f"Invalid input key [{node_id}]")
 
         workbench[node_id].outputs = {KeyIDStr("out_1"): input_update.value}
         partial_workbench_data[node_id] = workbench[node_id].model_dump(

services/web/server/src/simcore_service_webserver/projects/_controller/projects_states_rest.py

@@ -63,7 +63,7 @@ async def open_project(request: web.Request) -> web.Response:
         client_session_id = await request.json()
 
     except json.JSONDecodeError as exc:
-        raise web.HTTPBadRequest(reason="Invalid request body") from exc
+        raise web.HTTPBadRequest(text="Invalid request body") from exc
 
     try:
         project_type: ProjectType = await _projects_service.get_project_type(
@@ -74,7 +74,7 @@ async def open_project(request: web.Request) -> web.Response:
         )
         if project_type is ProjectType.TEMPLATE and user_role < UserRole.USER:
             # only USERS/TESTERS can do that
-            raise web.HTTPForbidden(reason="Wrong user role to open/edit a template")
+            raise web.HTTPForbidden(text="Wrong user role to open/edit a template")
 
         project = await _projects_service.get_project_for_user(
             request.app,
@@ -101,7 +101,7 @@ async def open_project(request: web.Request) -> web.Response:
             app=request.app,
             max_number_of_studies_per_user=product.max_open_studies_per_user,
         ):
-            raise HTTPLockedError(reason="Project is locked, try later")
+            raise HTTPLockedError(text="Project is locked, try later")
 
         # the project can be opened, let's update its product links
         await _projects_service.update_project_linked_product(
@@ -175,7 +175,7 @@ async def close_project(request: web.Request) -> web.Response:
         client_session_id = await request.json()
 
     except json.JSONDecodeError as exc:
-        raise web.HTTPBadRequest(reason="Invalid request body") from exc
+        raise web.HTTPBadRequest(text="Invalid request body") from exc
 
     # ensure the project exists
     await _projects_service.get_project_for_user(

services/web/server/src/simcore_service_webserver/projects/_controller/tags_rest.py

@@ -32,7 +32,7 @@ async def add_project_tag(request: web.Request):
             request.match_info["project_uuid"],
         )
     except KeyError as err:
-        raise web.HTTPBadRequest(reason=f"Invalid request parameter {err}") from err
+        raise web.HTTPBadRequest(text=f"Invalid request parameter {err}") from err
 
     project = await tags_api.add_tag(
         request.app,

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

@@ -469,10 +469,10 @@ async def create_project(  # pylint: disable=too-many-arguments,too-many-branche
         )
 
     except JsonSchemaValidationError as exc:
-        raise web.HTTPBadRequest(reason="Invalid project data") from exc
+        raise web.HTTPBadRequest(text="Invalid project data") from exc
 
     except ProjectNotFoundError as exc:
-        raise web.HTTPNotFound(reason=f"Project {exc.project_uuid} not found") from exc
+        raise web.HTTPNotFound(text=f"Project {exc.project_uuid} not found") from exc
 
     except (ProjectInvalidRightsError, WorkspaceAccessForbiddenError) as exc:
         raise web.HTTPForbidden from exc
@@ -485,7 +485,7 @@ async def create_project(  # pylint: disable=too-many-arguments,too-many-branche
                 user_id=user_id,
                 simcore_user_agent=simcore_user_agent,
             )
-        raise web.HTTPNotFound(reason=f"{exc}") from exc
+        raise web.HTTPNotFound(text=f"{exc}") from exc
 
     except asyncio.CancelledError:
         log.warning(

services/web/server/src/simcore_service_webserver/resource_usage/_pricing_plans_admin_rest.py

@@ -58,7 +58,7 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
             return await handler(request)
 
         except (ValueError, PricingUnitDuplicationError) as exc:
-            raise web.HTTPBadRequest(reason=f"{exc}") from exc
+            raise web.HTTPBadRequest(text=f"{exc}") from exc
 
         except RPCServerError as exc:
             # NOTE: This will be improved; we will add a mapping between

services/web/server/src/simcore_service_webserver/resource_usage/_pricing_plans_rest.py

@@ -39,7 +39,7 @@ async def wrapper(request: web.Request) -> web.StreamResponse:
             return await handler(request)
 
         except WalletAccessForbiddenError as exc:
-            raise web.HTTPForbidden(reason=f"{exc}") from exc
+            raise web.HTTPForbidden(text=f"{exc}") from exc
 
     return wrapper