Merge branch 'master' into is8102/add-search-api-in-storage

Author: giancarloromeo

packages/common-library/src/common_library/async_tools.py

@@ -2,12 +2,15 @@
 import datetime
 import functools
 import logging
+import sys
 from collections.abc import Awaitable, Callable, Coroutine
 from concurrent.futures import Executor
 from functools import wraps
 from inspect import isawaitable
 from typing import Any, ParamSpec, TypeVar, overload
 
+from .logging.logging_errors import create_troubleshooting_log_kwargs
+
 _logger = logging.getLogger(__name__)
 
 R = TypeVar("R")
@@ -102,11 +105,13 @@ async def cancel_wait_task(
             # from observing the cancellation/finalization of task.
             asyncio.wait_for(task, timeout=max_delay)
         )
-    except TimeoutError:
+    except TimeoutError as exc:
         _logger.exception(
-            "Timeout while cancelling task %s after %s seconds",
-            task.get_name(),
-            max_delay,
+            **create_troubleshooting_log_kwargs(
+                f"Timeout while cancelling task {task.get_name()} after {max_delay} seconds",
+                error=exc,
+                error_context={"task_name": task.get_name(), "max_delay": max_delay},
+            )
         )
         raise
     except asyncio.CancelledError:
@@ -117,7 +122,20 @@ async def cancel_wait_task(
             raise
     finally:
         if not task.done():
-            _logger.error("Failed to cancel %s", task.get_name())
+            current_exception = sys.exception()
+            _logger.error(
+                **create_troubleshooting_log_kwargs(
+                    f"Failed to cancel ask {task.get_name()}",
+                    error=(
+                        current_exception if current_exception else Exception("Unknown")
+                    ),
+                    error_context={
+                        "task_name": task.get_name(),
+                        "max_delay": max_delay,
+                    },
+                    tip="Consider increasing max_delay or fixing the task to handle cancellations properly",
+                )
+            )
         else:
             _logger.debug("Task %s cancelled", task.get_name())
 

packages/common-library/src/common_library/logging/__init__.py

@@ -1,5 +1,5 @@
 import logging
-from typing import Any, TypedDict
+from typing import Any, Final, TypedDict
 
 from common_library.error_codes import ErrorCodeStr
 from common_library.errors_classes import OsparcErrorMixin
@@ -9,6 +9,8 @@
 
 _logger = logging.getLogger(__name__)
 
+_MAX_LOGGED_CAUSES: Final[int] = 10
+
 
 def create_troubleshooting_log_message(
     user_error_msg: str,
@@ -36,7 +38,7 @@ def _collect_causes(exc: BaseException) -> str:
             seen.add(id(current))
             causes.append(f"[{type(current).__name__}]'{current}'")
             current = getattr(current, "__cause__", None)
-            if len(causes) > 10:  # Prevent excessive chains
+            if len(causes) > _MAX_LOGGED_CAUSES:  # Prevent excessive chains
                 causes.append("[... truncated]")
                 break
         return " <- ".join(causes)

packages/service-library/src/servicelib/logging_base.py renamed to packages/common-library/src/common_library/logging/logging_base.py

@@ -5,7 +5,7 @@
 import pytest
 from common_library.error_codes import create_error_code, parse_error_code_parts
 from common_library.errors_classes import OsparcErrorMixin
-from servicelib.logging_errors import (
+from common_library.logging.logging_errors import (
     create_troubleshooting_log_kwargs,
     create_troubleshooting_log_message,
 )

packages/service-library/src/servicelib/logging_errors.py renamed to packages/common-library/src/common_library/logging/logging_errors.py

@@ -1,10 +1,10 @@
 # pylint: disable=redefined-outer-name
 
 import logging
-from typing import Generator
+from collections.abc import Generator
 
 import pytest
-from servicelib.logging_utils_filtering import GeneralLogFilter
+from common_library.logging.logging_utils_filtering import GeneralLogFilter
 
 
 @pytest.fixture

packages/service-library/src/servicelib/logging_utils_filtering.py renamed to packages/common-library/src/common_library/logging/logging_utils_filtering.py

@@ -13,11 +13,11 @@
 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.logging.logging_errors import create_troubleshooting_log_kwargs
 from common_library.user_messages import user_message
 from models_library.basic_types import IDStr
 from models_library.rest_error import ErrorGet, ErrorItemType, LogMessageType
 
-from ..logging_errors import create_troubleshooting_log_kwargs
 from ..mimetype_constants import MIMETYPE_APPLICATION_JSON
 from ..rest_constants import RESPONSE_MODEL_POLICY
 from ..rest_responses import is_enveloped_from_text
@@ -202,7 +202,6 @@ def _handle_exception_as_http_error(
 
 
 def error_middleware_factory(api_version: str) -> Middleware:
-
     @web.middleware
     async def _middleware_handler(request: web.Request, handler: Handler):
         """

packages/service-library/tests/test_logging_errors.py renamed to packages/common-library/tests/test_logging_errors.py

@@ -5,10 +5,9 @@
 from functools import wraps
 from typing import Any, Final, ParamSpec, TypeVar
 
+from common_library.logging.logging_errors import create_troubleshooting_log_kwargs
 from pydantic import BaseModel, Field, NonNegativeFloat, PrivateAttr
 
-from .logging_errors import create_troubleshooting_log_kwargs
-
 _logger = logging.getLogger(__name__)
 
 _SKIPS_MESSAGE: Final[str] = "skip(s) of exception"

packages/service-library/tests/test_logging_utils_filtering.py renamed to packages/common-library/tests/test_logging_utils_filtering.py

@@ -2,6 +2,7 @@
 from collections.abc import Awaitable, Callable
 from typing import TypeVar
 
+from common_library.logging.logging_errors import create_troubleshooting_log_kwargs
 from fastapi import FastAPI, HTTPException, status
 from fastapi.encoders import jsonable_encoder
 from fastapi.exceptions import RequestValidationError
@@ -11,7 +12,6 @@
 from fastapi.responses import JSONResponse
 from pydantic import ValidationError
 
-from ..logging_errors import create_troubleshooting_log_kwargs
 from ..status_codes_utils import is_5xx_server_error
 
 validation_error_response_definition["properties"] = {