♻️ Refactor: Replace manual task cancellation with cancel_and_wait in garbage collector tasks

Author: pcrespov

services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_api_keys.py

@@ -8,6 +8,7 @@
 from collections.abc import AsyncIterator, Callable
 
 from aiohttp import web
+from common_library.async_utils import cancel_and_wait
 from tenacity import retry
 from tenacity.before_sleep import before_sleep_log
 from tenacity.wait import wait_exponential
@@ -67,10 +68,6 @@ async def _cleanup_ctx_fun(
         yield
 
         # tear-down
-        task.cancel()
-        try:
-            await task
-        except asyncio.CancelledError:
-            assert task.cancelled()  # nosec
+        await cancel_and_wait(task)
 
     return _cleanup_ctx_fun

services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_core.py

@@ -1,4 +1,4 @@
-""" Setup and running of periodic background task
+"""Setup and running of periodic background task
 
 
 Specifics of the gc implementation should go into garbage_collector_core.py
@@ -9,6 +9,7 @@
 from collections.abc import AsyncGenerator
 
 from aiohttp import web
+from common_library.async_tools import cancel_and_wait
 from servicelib.logging_utils import log_context
 
 from ._core import collect_garbage
@@ -49,18 +50,14 @@ async def run_background_task(app: web.Application) -> AsyncGenerator:
 
     # TEAR-DOWN -----
     # controlled cancelation of the gc task
-    try:
-        _logger.info("Stopping garbage collector...")
+    _logger.info("Stopping garbage collector...")
 
-        ack = gc_bg_task.cancel()
-        assert ack  # nosec
+    ack = gc_bg_task.cancel()
+    assert ack  # nosec
 
-        app[_GC_TASK_CONFIG]["force_stop"] = True
+    app[_GC_TASK_CONFIG]["force_stop"] = True
 
-        await gc_bg_task
-
-    except asyncio.CancelledError:
-        assert gc_bg_task.cancelled()  # nosec
+    await cancel_and_wait(gc_bg_task)
 
 
 async def _collect_garbage_periodically(app: web.Application):

services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_trash.py

@@ -1,5 +1,5 @@
 """
-    Scheduled tasks addressing users
+Scheduled tasks addressing users
 
 """
 
@@ -8,6 +8,7 @@
 from collections.abc import AsyncIterator, Callable
 
 from aiohttp import web
+from common_library.async_utils import cancel_and_wait
 from servicelib.logging_utils import log_context
 from tenacity import retry
 from tenacity.before_sleep import before_sleep_log
@@ -55,10 +56,6 @@ async def _cleanup_ctx_fun(
         yield
 
         # tear-down
-        task.cancel()
-        try:
-            await task
-        except asyncio.CancelledError:
-            assert task.cancelled()  # nosec
+        await cancel_and_wait(task)
 
     return _cleanup_ctx_fun

services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_users.py

@@ -8,6 +8,7 @@
 from collections.abc import AsyncIterator, Callable
 
 from aiohttp import web
+from common_library.async_utils import cancel_and_wait
 from models_library.users import UserID
 from servicelib.logging_utils import get_log_record_extra, log_context
 from tenacity import retry
@@ -107,10 +108,6 @@ async def _cleanup_ctx_fun(
         yield
 
         # tear-down
-        task.cancel()
-        try:
-            await task
-        except asyncio.CancelledError:
-            assert task.cancelled()  # nosec
+        await cancel_and_wait(task)
 
     return _cleanup_ctx_fun

services/web/server/src/simcore_service_webserver/payments/_tasks.py

@@ -5,6 +5,7 @@
 from typing import Any
 
 from aiohttp import web
+from common_library.async_utils import cancel_and_wait
 from models_library.api_schemas_webserver.wallets import PaymentID, PaymentMethodID
 from pydantic import HttpUrl, TypeAdapter
 from servicelib.aiohttp.typing_extension import CleanupContextFunc
@@ -143,10 +144,6 @@ async def _cleanup_ctx_fun(
         yield
 
         # tear-down
-        task.cancel()
-        try:
-            await task
-        except asyncio.CancelledError:
-            assert task.cancelled()  # nosec
+        await cancel_and_wait(task)
 
     return _cleanup_ctx_fun