✨ Refactor import statements and update deprecated function usage in FastAPI lifespan management

Author: pcrespov

packages/service-library/src/servicelib/fastapi/lifespan_utils.py

@@ -5,7 +5,8 @@
 from common_library.errors_classes import OsparcErrorMixin
 from fastapi import FastAPI
 from fastapi_lifespan_manager import State
-from servicelib.logging_utils import log_context
+
+from ..logging_utils import log_context
 
 
 class LifespanError(OsparcErrorMixin, RuntimeError): ...

packages/service-library/src/servicelib/fastapi/postgres_lifespan.py

@@ -5,11 +5,11 @@
 
 from fastapi import FastAPI
 from fastapi_lifespan_manager import State
-from servicelib.logging_utils import log_catch
 from settings_library.postgres import PostgresSettings
 from sqlalchemy.ext.asyncio import AsyncEngine
 
 from ..db_asyncpg_utils import create_async_engine_and_database_ready
+from ..logging_utils import log_catch
 from .lifespan_utils import LifespanOnStartupError, lifespan_context
 
 _logger = logging.getLogger(__name__)

packages/service-library/src/servicelib/fastapi/rabbitmq.py

@@ -1,4 +1,5 @@
 import logging
+import warnings
 
 from fastapi import FastAPI
 from models_library.rabbitmq_messages import RabbitMessageBase
@@ -55,6 +56,13 @@ def setup_rabbit(
         settings -- Rabbit settings or if None, the connection to rabbit is not done upon startup
         name -- name for the rmq client name
     """
+    warnings.warn(
+        "The 'setup_rabbit' function is deprecated and will be removed in a future release. "
+        "Please use 'rabbitmq_lifespan' for managing RabbitMQ connections.",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+
     app.state.rabbitmq_client = None  # RabbitMQClient | None
     app.state.rabbitmq_client_name = name
     app.state.rabbitmq_settings = settings

packages/service-library/src/servicelib/fastapi/rabbitmq_lifespan.py

@@ -4,9 +4,9 @@
 from fastapi import FastAPI
 from fastapi_lifespan_manager import State
 from pydantic import BaseModel, ValidationError
-from servicelib.rabbitmq import wait_till_rabbitmq_responsive
 from settings_library.rabbit import RabbitSettings
 
+from ..rabbitmq import wait_till_rabbitmq_responsive
 from .lifespan_utils import (
     LifespanOnStartupError,
     lifespan_context,

packages/service-library/src/servicelib/fastapi/redis_lifespan.py

@@ -6,9 +6,9 @@
 from fastapi import FastAPI
 from fastapi_lifespan_manager import State
 from pydantic import BaseModel, StringConstraints, ValidationError
-from servicelib.logging_utils import log_catch, log_context
 from settings_library.redis import RedisDatabase, RedisSettings
 
+from ..logging_utils import log_catch, log_context
 from ..redis import RedisClientSDK
 from .lifespan_utils import LifespanOnStartupError, lifespan_context
 
@@ -25,8 +25,8 @@ class RedisLifespanState(BaseModel):
     REDIS_CLIENT_DB: RedisDatabase
 
 
-async def redis_database_lifespan(_: FastAPI, state: State) -> AsyncIterator[State]:
-    _lifespan_name = f"{__name__}.{redis_database_lifespan.__name__}"
+async def redis_client_sdk_lifespan(_: FastAPI, state: State) -> AsyncIterator[State]:
+    _lifespan_name = f"{__name__}.{redis_client_sdk_lifespan.__name__}"
 
     with lifespan_context(_logger, logging.INFO, _lifespan_name, state) as called_state:
 
@@ -45,6 +45,8 @@ async def redis_database_lifespan(_: FastAPI, state: State) -> AsyncIterator[Sta
             logging.INFO,
             f"Creating redis client with name={redis_state.REDIS_CLIENT_NAME}",
         ):
+            # NOTE: sdk integrats waiting until connection is ready
+            # and will raise an exception if it cannot connect
             redis_client = RedisClientSDK(
                 redis_dsn_with_secrets,
                 client_name=redis_state.REDIS_CLIENT_NAME,
@@ -54,10 +56,9 @@ async def redis_database_lifespan(_: FastAPI, state: State) -> AsyncIterator[Sta
             yield {"REDIS_CLIENT_SDK": redis_client, **called_state}
         finally:
             # Teardown client
-            if redis_client:
-                with log_catch(_logger, reraise=False):
-                    await asyncio.wait_for(
-                        redis_client.shutdown(),
-                        # NOTE: shutdown already has a _HEALTHCHECK_TASK_TIMEOUT_S of 10s
-                        timeout=20,
-                    )
+            with log_catch(_logger, reraise=False):
+                await asyncio.wait_for(
+                    redis_client.shutdown(),
+                    # NOTE: shutdown already has a _HEALTHCHECK_TASK_TIMEOUT_S of 10s
+                    timeout=20,
+                )

packages/service-library/tests/fastapi/test_redis_lifespan.py

@@ -19,7 +19,7 @@
 from servicelib.fastapi.redis_lifespan import (
     RedisConfigurationError,
     RedisLifespanState,
-    redis_database_lifespan,
+    redis_client_sdk_lifespan,
 )
 from settings_library.application import BaseApplicationSettings
 from settings_library.redis import RedisDatabase, RedisSettings
@@ -65,7 +65,7 @@ async def my_app_settings(app: FastAPI) -> AsyncIterator[State]:
 
     app_lifespan = LifespanManager()
     app_lifespan.add(my_app_settings)
-    app_lifespan.add(redis_database_lifespan)
+    app_lifespan.add(redis_client_sdk_lifespan)
 
     assert not mock_redis_client_sdk.called
 
@@ -112,7 +112,7 @@ async def my_app_settings(app: FastAPI) -> AsyncIterator[State]:
 
     app_lifespan = LifespanManager()
     app_lifespan.add(my_app_settings)
-    app_lifespan.add(redis_database_lifespan)
+    app_lifespan.add(redis_client_sdk_lifespan)
 
     app = FastAPI(lifespan=app_lifespan)