rename aiopg key

Author: pcrespov

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

@@ -21,7 +21,7 @@
 APP_CONFIG_KEY: Final[str] = f"{__name__ }.config"
 APP_SETTINGS_KEY: Final[str] = f"{__name__ }.settings"
 
-APP_DB_ENGINE_KEY: Final[str] = f"{__name__ }.db_engine"
+APP_AIOPG_ENGINE_KEY: Final[str] = f"{__name__ }.aiopg_engine"
 
 APP_CLIENT_SESSION_KEY: Final[str] = f"{__name__ }.session"
 

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

@@ -53,7 +53,7 @@ async def connect_to_db(app: web.Application, settings: PostgresSettings) -> Non
     _set_async_engine_to_app_state(app, engine)
 
     _logger.debug(
-        "Setup engine: %s",
+        "Setup asyncpg engine: %s",
         await get_pg_engine_stateinfo(engine),
     )
 

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

@@ -29,7 +29,7 @@ async def create_async_engine_and_pg_database_ready(
     - returns engine
     """
     with log_context(
-        _logger, logging.DEBUG, f"connection to db {settings.dsn_with_async_sqlalchemy}"
+        _logger, logging.DEBUG, f"Connecting to {settings.dsn_with_async_sqlalchemy}"
     ):
         engine: AsyncEngine = create_async_engine(
             settings.dsn_with_async_sqlalchemy,
@@ -42,7 +42,9 @@ async def create_async_engine_and_pg_database_ready(
             future=True,  # this uses sqlalchemy 2.0 API, shall be removed when sqlalchemy 2.0 is released
         )
 
-    with log_context(_logger, logging.DEBUG, "migration"):
+    with log_context(
+        _logger, logging.DEBUG, f"Migrating db {settings.dsn_with_async_sqlalchemy}"
+    ):
         try:
             await raise_if_migration_not_ready(engine)
         except Exception:

services/storage/src/simcore_service_storage/constants.py

@@ -39,7 +39,7 @@
 MAX_CONCURRENT_REST_CALLS: Final[int] = 10
 
 # DATABASE ----------------------------
-APP_DB_ENGINE_KEY = f"{__name__}.db_engine"
+APP_AIOPG_ENGINE_KEY = f"{__name__}.db_engine"
 MAX_CONCURRENT_DB_TASKS: Final[int] = 2
 
 # DATA STORAGE MANAGER ----------------------------------

services/storage/src/simcore_service_storage/db.py

@@ -13,7 +13,7 @@
 )
 from tenacity import retry
 
-from .constants import APP_CONFIG_KEY, APP_DB_ENGINE_KEY
+from .constants import APP_AIOPG_ENGINE_KEY, APP_CONFIG_KEY
 
 _logger = logging.getLogger(__name__)
 
@@ -46,7 +46,7 @@ async def postgres_cleanup_ctx(app: web.Application):
     ) as engine:
 
         assert engine  # nosec
-        app[APP_DB_ENGINE_KEY] = engine
+        app[APP_AIOPG_ENGINE_KEY] = engine
         _logger.info("Created pg engine for %s", dsn)
         yield  # ----------
         _logger.info("Deleting pg engine for %s", dsn)
@@ -55,19 +55,19 @@ async def postgres_cleanup_ctx(app: web.Application):
 
 async def is_service_responsive(app: web.Application) -> bool:
     """Returns true if the app can connect to db service"""
-    return await is_pg_responsive(engine=app[APP_DB_ENGINE_KEY])
+    return await is_pg_responsive(engine=app[APP_AIOPG_ENGINE_KEY])
 
 
 def get_engine_state(app: web.Application) -> dict[str, Any]:
-    engine: Engine | None = app.get(APP_DB_ENGINE_KEY)
+    engine: Engine | None = app.get(APP_AIOPG_ENGINE_KEY)
     if engine:
         engine_info: dict[str, Any] = get_pg_engine_stateinfo(engine)
         return engine_info
     return {}
 
 
 def setup_db(app: web.Application):
-    app[APP_DB_ENGINE_KEY] = None
+    app[APP_AIOPG_ENGINE_KEY] = None
 
     # app is created at this point but not yet started
     _logger.debug("Setting up %s [service: %s] ...", __name__, "postgres")

services/storage/src/simcore_service_storage/db_tokens.py

@@ -7,7 +7,7 @@
 from models_library.users import UserID
 from simcore_postgres_database.storage_models import tokens
 
-from .constants import APP_CONFIG_KEY, APP_DB_ENGINE_KEY
+from .constants import APP_AIOPG_ENGINE_KEY, APP_CONFIG_KEY
 
 log = logging.getLogger(__name__)
 
@@ -27,7 +27,7 @@ async def get_api_token_and_secret(
     app: web.Application, user_id: UserID
 ) -> tuple[str, str]:
     # from the client side together with the userid?
-    engine = app[APP_DB_ENGINE_KEY]
+    engine = app[APP_AIOPG_ENGINE_KEY]
 
     # defaults from config if any, othewise None
     api_token = app[APP_CONFIG_KEY].BF_API_KEY

services/storage/src/simcore_service_storage/simcore_s3_dsm.py

@@ -38,8 +38,8 @@
 
 from . import db_file_meta_data, db_projects, db_tokens
 from .constants import (
+    APP_AIOPG_ENGINE_KEY,
     APP_CONFIG_KEY,
-    APP_DB_ENGINE_KEY,
     DATCORE_ID,
     EXPAND_DIR_MAX_ITEM_COUNT,
     MAX_CONCURRENT_S3_TASKS,
@@ -1084,7 +1084,7 @@ def create_simcore_s3_data_manager(app: web.Application) -> SimcoreS3DataManager
     cfg: Settings = app[APP_CONFIG_KEY]
     assert cfg.STORAGE_S3  # nosec
     return SimcoreS3DataManager(
-        engine=app[APP_DB_ENGINE_KEY],
+        engine=app[APP_AIOPG_ENGINE_KEY],
         simcore_bucket_name=parse_obj_as(S3BucketName, cfg.STORAGE_S3.S3_BUCKET_NAME),
         app=app,
         settings=cfg,

services/web/server/src/simcore_service_webserver/_constants.py

@@ -4,8 +4,8 @@
 from typing import Final
 
 from servicelib.aiohttp.application_keys import (
+    APP_AIOPG_ENGINE_KEY,
     APP_CONFIG_KEY,
-    APP_DB_ENGINE_KEY,
     APP_FIRE_AND_FORGET_TASKS_KEY,
     APP_SETTINGS_KEY,
 )
@@ -30,7 +30,7 @@
 
 __all__: tuple[str, ...] = (
     "APP_CONFIG_KEY",
-    "APP_DB_ENGINE_KEY",
+    "APP_AIOPG_ENGINE_KEY",
     "APP_FIRE_AND_FORGET_TASKS_KEY",
     "APP_SETTINGS_KEY",
     "RQT_USERID_KEY",

services/web/server/src/simcore_service_webserver/api_keys/_db.py

@@ -10,7 +10,7 @@
 from models_library.basic_types import IdInt
 from models_library.products import ProductName
 from models_library.users import UserID
-from servicelib.aiohttp.application_keys import APP_DB_ENGINE_KEY
+from servicelib.aiohttp.application_keys import APP_AIOPG_ENGINE_KEY
 from simcore_postgres_database.models.api_keys import api_keys
 from sqlalchemy.dialects.postgresql import insert as pg_insert
 
@@ -23,7 +23,7 @@ class ApiKeyRepo:
 
     @classmethod
     def create_from_app(cls, app: web.Application):
-        return cls(engine=app[APP_DB_ENGINE_KEY])
+        return cls(engine=app[APP_AIOPG_ENGINE_KEY])
 
     async def list_names(
         self, *, user_id: UserID, product_name: ProductName

services/web/server/src/simcore_service_webserver/db/_aiopg.py

@@ -12,7 +12,7 @@
 from aiopg.sa import Engine, create_engine
 from models_library.utils.json_serialization import json_dumps
 from servicelib.aiohttp.aiopg_utils import is_pg_responsive
-from servicelib.aiohttp.application_keys import APP_DB_ENGINE_KEY
+from servicelib.aiohttp.application_keys import APP_AIOPG_ENGINE_KEY
 from servicelib.retry_policies import PostgresRetryPolicyUponInitialization
 from simcore_postgres_database.errors import DBAPIError
 from simcore_postgres_database.utils_aiopg import (
@@ -53,43 +53,48 @@ async def postgres_cleanup_ctx(app: web.Application) -> AsyncIterator[None]:
 
     settings = get_plugin_settings(app)
     aiopg_engine = await _ensure_pg_ready(settings)
-    app[APP_DB_ENGINE_KEY] = aiopg_engine
+    app[APP_AIOPG_ENGINE_KEY] = aiopg_engine
 
-    _logger.info("pg engine created %s", json_dumps(get_engine_state(app), indent=1))
+    _logger.info(
+        "app[APP_AIOPG_ENGINE_KEY] created %s",
+        json_dumps(get_engine_state(app), indent=1),
+    )
 
     yield  # -------------------
 
-    if aiopg_engine is not app.get(APP_DB_ENGINE_KEY):
-        _logger.critical("app does not hold right db engine. Somebody has changed it??")
+    if aiopg_engine is not app.get(APP_AIOPG_ENGINE_KEY):
+        _logger.critical(
+            "app[APP_AIOPG_ENGINE_KEY] does not hold right db engine. Somebody has changed it??"
+        )
 
     await close_engine(aiopg_engine)
 
     _logger.debug(
-        "pg engine created after shutdown %s (closed=%s): %s",
+        "app[APP_AIOPG_ENGINE_KEY] after shutdown %s (closed=%s): %s",
         aiopg_engine.dsn,
         aiopg_engine.closed,
         json_dumps(get_engine_state(app), indent=1),
     )
 
 
 def is_service_enabled(app: web.Application):
-    return app.get(APP_DB_ENGINE_KEY) is not None
+    return app.get(APP_AIOPG_ENGINE_KEY) is not None
 
 
 async def is_service_responsive(app: web.Application):
     """Returns true if the app can connect to db service"""
     if not is_service_enabled(app):
         return False
-    return await is_pg_responsive(engine=app[APP_DB_ENGINE_KEY])
+    return await is_pg_responsive(engine=app[APP_AIOPG_ENGINE_KEY])
 
 
 def get_engine_state(app: web.Application) -> dict[str, Any]:
-    engine: Engine | None = app.get(APP_DB_ENGINE_KEY)
+    engine: Engine | None = app.get(APP_AIOPG_ENGINE_KEY)
     if engine:
         pg_engine_stateinfo: dict[str, Any] = get_pg_engine_stateinfo(engine)
         return pg_engine_stateinfo
     return {}
 
 
 def get_database_engine(app: web.Application) -> Engine:
-    return cast(Engine, app[APP_DB_ENGINE_KEY])
+    return cast(Engine, app[APP_AIOPG_ENGINE_KEY])