🐛 Ensure stack is logged when removing task from task manager (ITISFoundation#5514)

Author: bisgaard-itis

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

@@ -1,3 +1,5 @@
+import logging
+
 from aiohttp import web
 
 from ...json_serialization import json_dumps
@@ -7,18 +9,22 @@
     TaskNotFoundError,
 )
 
+_logger = logging.getLogger(__name__)
+
 
 @web.middleware
 async def base_long_running_error_handler(request, handler):
     try:
         return await handler(request)
     except (TaskNotFoundError, TaskNotCompletedError) as exc:
+        _logger.debug("", exc_info=True)
         error_fields = dict(code=exc.code, message=f"{exc}")
         raise web.HTTPNotFound(
             reason=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

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

@@ -1,3 +1,5 @@
+import logging
+
 from fastapi import status
 from fastapi.encoders import jsonable_encoder
 from starlette.requests import Request
@@ -9,10 +11,13 @@
     TaskNotFoundError,
 )
 
+_logger = logging.getLogger(__name__)
+
 
 async def base_long_running_error_handler(
     _: Request, exception: BaseLongRunningError
 ) -> JSONResponse:
+    _logger.debug("%s", exception, stack_info=True)
     error_fields = dict(code=exception.code, message=f"{exception}")
     status_code = (
         status.HTTP_404_NOT_FOUND

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

@@ -316,12 +316,8 @@ async def remove_task(
         reraise_errors: bool = True,
     ) -> None:
         """cancels and removes task"""
-        logger.debug(
-            "Attempting to remove task with task_id=%s.", task_id, exc_info=True
-        )
         try:
             tracked_task = self._get_tracked_task(task_id, with_task_context)
-            logger.debug("Succeeded in getting task with task_id=%s", task_id)
         except TaskNotFoundError:
             if reraise_errors:
                 raise
@@ -330,10 +326,8 @@ async def remove_task(
             await self._cancel_tracked_task(
                 tracked_task.task, task_id, reraise_errors=reraise_errors
             )
-            logger.debug("Succeeded in canceling task with task_id=%s", task_id)
         finally:
             del self._tasks_groups[tracked_task.task_name][task_id]
-            logger.debug("Removed task_id=%s from tracked tasks", task_id)
 
     async def close(self) -> None:
         """