adds logs on shutdown

Author: pcrespov

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

@@ -13,7 +13,7 @@
 
 from ..async_utils import cancel_wait_task
 from ..background_task import periodic
-from ..logging_utils import log_catch
+from ..logging_utils import log_catch, log_context
 from ._constants import (
     DEFAULT_DECODE_RESPONSES,
     DEFAULT_HEALTH_CHECK_INTERVAL,
@@ -77,16 +77,20 @@ async def _periodic_check_health() -> None:
         )
 
     async def shutdown(self) -> None:
-        if self._health_check_task:
-            assert self._health_check_task_started_event  # nosec
-            await self._health_check_task_started_event.wait()  # NOTE: wait for the health check task to have started once before we can cancel it
-            await cancel_wait_task(self._health_check_task)
+        with log_context(
+            _logger, level=logging.DEBUG, msg=f"Shutdown RedisClientSDK {self}"
+        ):
+            if self._health_check_task:
+                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_wait_task(self._health_check_task, max_delay=3)
 
-        await self._client.aclose(close_connection_pool=True)
+            await self._client.aclose(close_connection_pool=True)
 
     async def ping(self) -> bool:
         with log_catch(_logger, reraise=False):
-            # FIXME: this ping should NOT retry!?
+            # NOTE: retry_* input parameters from aioredis.from_url do not apply for the ping call
             await self._client.ping()
             return True
         return False

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

@@ -10,6 +10,7 @@
 from contextlib import AbstractAsyncContextManager
 
 import pytest
+from pytest_mock import MockerFixture
 from redis.exceptions import LockError, LockNotOwnedError
 from servicelib.redis import RedisClientSDK
 from settings_library.redis import RedisDatabase, RedisSettings
@@ -133,11 +134,17 @@ async def test_regression_fails_on_redis_service_outage(
     mock_redis_socket_timeout: None,
     pause_container_in_context: Callable[[str], AbstractAsyncContextManager[None]],
     redis_client_sdk: RedisClientSDK,
+    mocker: MockerFixture,
 ):
+
+    redis_client_ping = mocker.spy(redis_client_sdk._client, "ping")
+
     assert await redis_client_sdk.ping() is True
+    assert redis_client_ping.call_count == 1
 
     async with pause_container_in_context("redis"):
         # no connection available any longer should not hang but timeout
         assert await redis_client_sdk.ping() is False
+        assert redis_client_ping.call_count == 2
 
     assert await redis_client_sdk.ping() is True