rename

Author: pcrespov

packages/celery-library/src/celery_library/task.py

@@ -12,7 +12,7 @@
     AbortableTask,
 )
 from celery.exceptions import Ignore  # type: ignore[import-untyped]
-from common_library.async_tools import cancel_and_wait
+from common_library.async_tools import cancel_and_shielded_wait
 from pydantic import NonNegativeInt
 from servicelib.celery.models import TaskID
 
@@ -62,7 +62,7 @@ async def abort_monitor():
                             abortable_result = AbortableAsyncResult(task_id, app=app)
                             while not main_task.done():
                                 if abortable_result.is_aborted():
-                                    await cancel_and_wait(
+                                    await cancel_and_shielded_wait(
                                         main_task,
                                         max_delay=_DEFAULT_CANCEL_TASK_TIMEOUT.total_seconds(),
                                     )

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

@@ -69,7 +69,7 @@ async def maybe_await(
     return obj
 
 
-async def cancel_and_wait(
+async def cancel_and_shielded_wait(
     task: asyncio.Task, *, max_delay: float | None = None
 ) -> None:
     """Cancels the given task and waits for it to complete.

packages/common-library/tests/test_async_tools.py

@@ -6,7 +6,7 @@
 
 import pytest
 from common_library.async_tools import (
-    cancel_and_wait,
+    cancel_and_shielded_wait,
     delayed_start,
     make_async,
     maybe_await,
@@ -121,7 +121,7 @@ async def coro():
     await asyncio.sleep(0.1)  # Let coro start
 
     start = time.time()
-    await cancel_and_wait(task)
+    await cancel_and_shielded_wait(task)
 
     elapsed = time.time() - start
     assert elapsed < SLEEP_TIME, "Task should be cancelled quickly"
@@ -149,7 +149,7 @@ async def coro():
 
     async def outer_coro():
         try:
-            await cancel_and_wait(inner_task)
+            await cancel_and_shielded_wait(inner_task)
         except asyncio.CancelledError:
             assert (
                 not inner_task.cancelled()
@@ -194,7 +194,7 @@ async def slow_cleanup_coro():
 
     # Cancel with a max_delay shorter than cleanup time
     with pytest.raises(TimeoutError):
-        await cancel_and_wait(
+        await cancel_and_shielded_wait(
             task, max_delay=CLEANUP_TIME / 10
         )  # 0.2 seconds < 2 seconds cleanup
 

packages/service-library/src/servicelib/background_task.py

@@ -6,7 +6,7 @@
 from collections.abc import AsyncIterator, Awaitable, Callable, Coroutine
 from typing import Any, Final, ParamSpec, TypeVar
 
-from common_library.async_tools import cancel_and_wait, delayed_start
+from common_library.async_tools import cancel_and_shielded_wait, delayed_start
 from tenacity import TryAgain, before_sleep_log, retry, retry_if_exception_type
 from tenacity.wait import wait_fixed
 
@@ -142,4 +142,4 @@ async def periodic_task(
         if asyncio_task is not None:
             # NOTE: this stopping is shielded to prevent the cancellation to propagate
             # into the stopping procedure
-            await asyncio.shield(cancel_and_wait(asyncio_task, max_delay=stop_timeout))
+            await cancel_and_shielded_wait(asyncio_task, max_delay=stop_timeout)

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

@@ -9,7 +9,7 @@
 from typing import Any, Final, Protocol, TypeAlias
 from uuid import uuid4
 
-from common_library.async_tools import cancel_and_wait
+from common_library.async_tools import cancel_and_shielded_wait
 from models_library.api_schemas_long_running_tasks.base import TaskProgress
 from pydantic import PositiveFloat
 from servicelib.background_task import create_periodic_task
@@ -105,7 +105,7 @@ async def teardown(self) -> None:
 
         if self._stale_tasks_monitor_task:
             with log_catch(_logger, reraise=False):
-                await cancel_and_wait(
+                await cancel_and_shielded_wait(
                     self._stale_tasks_monitor_task, max_delay=_CANCEL_TASK_TIMEOUT
                 )
 

packages/service-library/src/servicelib/redis/_client.py

@@ -8,11 +8,11 @@
 
 import redis.asyncio as aioredis
 import redis.exceptions
+from common_library.async_tools import cancel_and_shielded_wait
 from redis.asyncio.lock import Lock
 from redis.asyncio.retry import Retry
 from redis.backoff import ExponentialBackoff
 
-from ..async_utils import cancel_and_wait
 from ..background_task import periodic
 from ..logging_utils import log_catch, log_context
 from ._constants import (
@@ -88,7 +88,7 @@ async def shutdown(self) -> None:
                 assert self._health_check_task_started_event  # nosec
                 # NOTE: wait for the health check task to have started once before we can cancel it
                 await self._health_check_task_started_event.wait()
-                await cancel_and_wait(
+                await cancel_and_shielded_wait(
                     self._health_check_task, max_delay=_HEALTHCHECK_TASK_TIMEOUT_S
                 )
 

packages/service-library/tests/rabbitmq/test_rabbitmq_rpc_interfaces_async_jobs.py

@@ -4,7 +4,7 @@
 from dataclasses import dataclass, field
 
 import pytest
-from common_library.async_tools import cancel_and_wait
+from common_library.async_tools import cancel_and_shielded_wait
 from faker import Faker
 from models_library.api_schemas_rpc_async_jobs.async_jobs import (
     AsyncJobGet,
@@ -137,7 +137,7 @@ async def setup(self) -> None:
     yield
 
     for task in fake_server.tasks:
-        await cancel_and_wait(task)
+        await cancel_and_shielded_wait(task)
 
 
 @pytest.mark.parametrize("method", ["result", "status", "cancel"])

packages/service-library/tests/redis/test_project_lock.py

@@ -10,7 +10,7 @@
 from uuid import UUID
 
 import pytest
-from common_library.async_tools import cancel_and_wait
+from common_library.async_tools import cancel_and_shielded_wait
 from faker import Faker
 from models_library.projects import ProjectID
 from models_library.projects_access import Owner
@@ -141,4 +141,4 @@ async def _locked_fct() -> None:
     with pytest.raises(ProjectLockError):
         await _locked_fct()
 
-    await cancel_and_wait(task1)
+    await cancel_and_shielded_wait(task1)

packages/service-library/tests/test_background_task.py

@@ -13,7 +13,7 @@
 from unittest.mock import AsyncMock
 
 import pytest
-from common_library.async_tools import cancel_and_wait
+from common_library.async_tools import cancel_and_shielded_wait
 from faker import Faker
 from pytest_mock.plugin import MockerFixture
 from servicelib.background_task import create_periodic_task, periodic, periodic_task
@@ -78,7 +78,10 @@ async def _creator(
     yield _creator
     # cleanup
     await asyncio.gather(
-        *(cancel_and_wait(t, max_delay=stop_task_timeout) for t in created_tasks)
+        *(
+            cancel_and_shielded_wait(t, max_delay=stop_task_timeout)
+            for t in created_tasks
+        )
     )
 
 

packages/service-library/tests/test_background_task_utils.py

@@ -13,7 +13,7 @@
 
 import arrow
 import pytest
-from common_library.async_tools import cancel_and_wait
+from common_library.async_tools import cancel_and_shielded_wait
 from servicelib.background_task_utils import exclusive_periodic
 from servicelib.redis import RedisClientSDK
 from settings_library.redis import RedisDatabase
@@ -71,7 +71,7 @@ async def _sleep_task(sleep_interval: float, on_sleep_events: mock.Mock) -> None
 
     await _assert_on_sleep_done(sleep_events, stop_after=stop_after)
 
-    await cancel_and_wait(task, max_delay=5)
+    await cancel_and_shielded_wait(task, max_delay=5)
 
     events_timestamps: tuple[float, ...] = tuple(
         x.args[0].timestamp() for x in sleep_events.call_args_list