✨ Add lifespan call tracking for PostgreSQL database in FastAPI

Author: pcrespov

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

@@ -10,7 +10,7 @@
 from sqlalchemy.ext.asyncio import AsyncEngine
 
 from ..db_asyncpg_utils import create_async_engine_and_database_ready
-from .lifespan_utils import LifespanOnStartupError
+from .lifespan_utils import LifespanOnStartupError, record_lifespan_called_once
 
 _logger = logging.getLogger(__name__)
 
@@ -32,6 +32,9 @@ async def postgres_database_lifespan(_: FastAPI, state: State) -> AsyncIterator[
 
     with log_context(_logger, logging.INFO, f"{__name__}"):
 
+        # Mark lifespan as called
+        called_state = record_lifespan_called_once(state, "postgres_database_lifespan")
+
         settings = state[PostgresLifespanState.POSTGRES_SETTINGS]
 
         if settings is None or not isinstance(settings, PostgresSettings):
@@ -48,6 +51,7 @@ async def postgres_database_lifespan(_: FastAPI, state: State) -> AsyncIterator[
 
             yield {
                 PostgresLifespanState.POSTGRES_ASYNC_ENGINE: async_engine,
+                **called_state,
             }
 
         finally:

packages/settings-library/src/settings_library/rabbit.py

@@ -2,6 +2,7 @@
 
 from pydantic.networks import AnyUrl
 from pydantic.types import SecretStr
+from pydantic_settings import SettingsConfigDict
 
 from .base import BaseCustomSettings
 from .basic_types import PortInt
@@ -33,3 +34,17 @@ def dsn(self) -> str:
             )
         )
         return rabbit_dsn
+
+    model_config = SettingsConfigDict(
+        json_schema_extra={
+            "examples": [
+                # minimal required
+                {
+                    "RABBIT_SECURE": "1",
+                    "RABBIT_HOST": "localhost",
+                    "RABBIT_USER": "user",
+                    "RABBIT_PASSWORD": "foobar",  # NOSONAR
+                }
+            ],
+        }
+    )

packages/settings-library/src/settings_library/redis.py

@@ -52,9 +52,6 @@ def build_redis_dsn(self, db_index: RedisDatabase) -> str:
             "examples": [
                 # minimal required
                 {
-                    "REDIS_SECURE": "0",
-                    "REDIS_HOST": "localhost",
-                    "REDIS_PORT": "6379",
                     "REDIS_USER": "user",
                     "REDIS_PASSWORD": "foobar",  # NOSONAR
                 }