🐛 Update error handling to use 'text' instead of 'reason' for HTTP responses in error handlers

Author: pcrespov

packages/service-library/src/servicelib/aiohttp/long_running_tasks/_error_handlers.py

@@ -18,13 +18,13 @@ async def base_long_running_error_handler(request, handler):
         return await handler(request)
     except (TaskNotFoundError, TaskNotCompletedError) as exc:
         _logger.debug("", exc_info=True)
-        error_fields = dict(code=exc.code, message=f"{exc}")
+        error_fields = {"code": exc.code, "message": f"{exc}"}
         raise web.HTTPNotFound(
-            reason=f"{json_dumps(error_fields)}",
+            text=f"{json_dumps(error_fields)}",
         ) from exc
     except TaskCancelledError as exc:
         # NOTE: only use-case would be accessing an already cancelled task
         # which should not happen, so we return a conflict
         _logger.debug("", exc_info=True)
-        error_fields = dict(code=exc.code, message=f"{exc}")
-        raise web.HTTPConflict(reason=f"{json_dumps(error_fields)}") from exc
+        error_fields = {"code": exc.code, "message": f"{exc}"}
+        raise web.HTTPConflict(text=f"{json_dumps(error_fields)}") from exc

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

@@ -101,11 +101,11 @@ async def middleware_handler(request: web.Request, handler: Handler):
             log_exception = None
             raise resp from exc
         except asyncio.CancelledError as exc:
-            resp = web.HTTPInternalServerError(reason=f"{exc}")
+            resp = web.HTTPInternalServerError(text=f"{exc}")
             log_exception = exc
             raise resp from exc
         except Exception as exc:  # pylint: disable=broad-except
-            resp = web.HTTPInternalServerError(reason=f"{exc}")
+            resp = web.HTTPInternalServerError(text=f"{exc}")
             resp.__cause__ = exc
             log_exception = exc
             raise resp from exc

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

@@ -209,7 +209,7 @@ async def parse_request_body_as(
             try:
                 body = await request.json()
             except json.decoder.JSONDecodeError as err:
-                raise web.HTTPBadRequest(reason=f"Invalid json in body: {err}") from err
+                raise web.HTTPBadRequest(text=f"Invalid json in body: {err}") from err
 
         if hasattr(model_schema_cls, "model_validate"):
             # NOTE: model_schema can be 'list[T]' or 'dict[T]' which raise TypeError

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

@@ -112,7 +112,7 @@ async def raise_error(_request: web.Request):
 
     @staticmethod
     async def raise_error_with_reason(_request: web.Request):
-        raise web.HTTPNotFound(reason="I did not find it")
+        raise web.HTTPNotFound(reason="A short phrase")
 
     @staticmethod
     async def raise_success(_request: web.Request):