✨ Refactor: Rename async engine creation function for clarity and deprecate old function

Author: pcrespov

packages/service-library/src/servicelib/aiohttp/db_asyncpg_engine.py

@@ -15,7 +15,7 @@
 )
 from sqlalchemy.ext.asyncio import AsyncEngine
 
-from ..db_asyncpg_utils import create_async_engine_and_database_ready
+from ..db_asyncpg_utils import create_async_engine_and_wait_for_database_ready
 from ..logging_utils import log_context
 
 APP_DB_ASYNC_ENGINE_KEY: Final[str] = f"{__name__ }.AsyncEngine"
@@ -55,7 +55,7 @@ async def connect_to_db(app: web.Application, settings: PostgresSettings) -> Non
         "Connecting app[APP_DB_ASYNC_ENGINE_KEY] to postgres with %s",
         f"{settings=}",
     ):
-        engine = await create_async_engine_and_database_ready(settings)
+        engine = await create_async_engine_and_wait_for_database_ready(settings)
         _set_async_engine_to_app_state(app, engine)
 
     _logger.info(

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

@@ -1,4 +1,5 @@
 import logging
+import warnings
 
 from fastapi import FastAPI
 from settings_library.postgres import PostgresSettings
@@ -17,6 +18,11 @@
 
 @retry(**PostgresRetryPolicyUponInitialization(_logger).kwargs)
 async def connect_to_db(app: FastAPI, settings: PostgresSettings) -> None:
+    warnings.warn(
+        "The 'connect_to_db' function is deprecated and will be removed in a future release. "
+        "Please use 'postgres_lifespan' instead for managing the database connection lifecycle.",
+        DeprecationWarning,
+    )
     with log_context(
         _logger, logging.DEBUG, f"connection to db {settings.dsn_with_async_sqlalchemy}"
     ):

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

@@ -14,7 +14,7 @@
 
 
 @retry(**PostgresRetryPolicyUponInitialization(_logger).kwargs)
-async def create_async_engine_and_database_ready(
+async def create_async_engine_and_wait_for_database_ready(
     settings: PostgresSettings,
 ) -> AsyncEngine:
     """

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

@@ -7,7 +7,7 @@
 )
 from sqlalchemy.ext.asyncio import AsyncEngine
 
-from ..db_asyncpg_utils import create_async_engine_and_database_ready
+from ..db_asyncpg_utils import create_async_engine_and_wait_for_database_ready
 from ..logging_utils import log_context
 
 _logger = logging.getLogger(__name__)
@@ -19,7 +19,7 @@ async def connect_to_db(app: FastAPI, settings: PostgresSettings) -> None:
         logging.DEBUG,
         f"Connecting and migraging {settings.dsn_with_async_sqlalchemy}",
     ):
-        engine = await create_async_engine_and_database_ready(settings)
+        engine = await create_async_engine_and_wait_for_database_ready(settings)
 
     app.state.engine = engine
     _logger.debug(

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

@@ -7,7 +7,7 @@
 from settings_library.postgres import PostgresSettings
 from sqlalchemy.ext.asyncio import AsyncEngine
 
-from ..db_asyncpg_utils import create_async_engine_and_database_ready
+from ..db_asyncpg_utils import create_async_engine_and_wait_for_database_ready
 
 _logger = logging.getLogger(__name__)
 
@@ -30,8 +30,8 @@ async def setup_postgres_database(_, state: State) -> AsyncIterator[State]:
         ]
         assert isinstance(pg_settings, PostgresSettings)  # nosec
 
-        async_engine: AsyncEngine = await create_async_engine_and_database_ready(
-            pg_settings
+        async_engine: AsyncEngine = (
+            await create_async_engine_and_wait_for_database_ready(pg_settings)
         )
 
         yield {PostgresLifespanStateKeys.POSTGRES_ASYNC_ENGINE: async_engine}

services/director-v2/src/simcore_service_director_v2/modules/db/_asyncpg.py

@@ -2,7 +2,7 @@
 
 from fastapi import FastAPI
 from servicelib.db_asyncpg_utils import (
-    create_async_engine_and_database_ready,
+    create_async_engine_and_wait_for_database_ready,
 )
 from servicelib.logging_utils import log_context
 from settings_library.postgres import PostgresSettings
@@ -17,7 +17,7 @@ async def asyncpg_connect_to_db(app: FastAPI, settings: PostgresSettings) -> Non
         logging.DEBUG,
         f"Connecting and migraging {settings.dsn_with_async_sqlalchemy}",
     ):
-        engine = await create_async_engine_and_database_ready(settings)
+        engine = await create_async_engine_and_wait_for_database_ready(settings)
 
     app.state.asyncpg_engine = engine
     _logger.debug(