♻️ Minor refactor of RUT API (#4803)

Author: pcrespov

packages/models-library/src/models_library/api_schemas_resource_usage_tracker/credit_transactions.py

@@ -1,5 +1,10 @@
+from datetime import datetime
 from decimal import Decimal
 
+from models_library.products import ProductName
+from models_library.resource_tracker import CreditTransactionId
+from models_library.users import UserID
+from models_library.wallets import WalletID
 from pydantic import BaseModel, validator
 
 from ..wallets import WalletID
@@ -13,3 +18,20 @@ class WalletTotalCredits(BaseModel):
     @classmethod
     def ensure_rounded(cls, v):
         return round(v, 2)
+
+
+class CreditTransactionCreateBody(BaseModel):
+    product_name: ProductName
+    wallet_id: WalletID
+    wallet_name: str
+    user_id: UserID
+    user_email: str
+    osparc_credits: Decimal
+    payment_transaction_id: str
+    created_at: datetime
+
+
+class CreditTransactionCreated(BaseModel):
+    """Response Create Credit Transaction V1 Credit Transactions Post"""
+
+    credit_transaction_id: CreditTransactionId

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

@@ -9,50 +9,44 @@
 from sqlalchemy.ext.asyncio import AsyncEngine, create_async_engine
 from tenacity import retry
 
+from .logging_utils import log_context
 from .retry_policies import PostgresRetryPolicyUponInitialization
 
-logger = logging.getLogger(__name__)
+_logger = logging.getLogger(__name__)
 
 
-@retry(**PostgresRetryPolicyUponInitialization(logger).kwargs)
+@retry(**PostgresRetryPolicyUponInitialization(_logger).kwargs)
 async def connect_to_db(app: FastAPI, cfg: PostgresSettings) -> None:
-    logger.debug("Connecting db ...")
-
-    engine: AsyncEngine = create_async_engine(
-        cfg.dsn_with_async_sqlalchemy,
-        pool_size=cfg.POSTGRES_MINSIZE,
-        max_overflow=cfg.POSTGRES_MAXSIZE - cfg.POSTGRES_MINSIZE,
-        connect_args={
-            "server_settings": {"application_name": cfg.POSTGRES_CLIENT_NAME}
-        },
-        pool_pre_ping=True,  # https://docs.sqlalchemy.org/en/14/core/pooling.html#dealing-with-disconnects
-        future=True,  # this uses sqlalchemy 2.0 API, shall be removed when sqlalchemy 2.0 is released
-    )
-
-    logger.debug("Connected to %s", engine.url)  # pylint: disable=no-member
-
-    logger.debug("Checking db migration...")
-    try:
-        await raise_if_migration_not_ready(engine)
-    except Exception:
-        # NOTE: engine must be closed because retry will create a new engine
-        await engine.dispose()
-        raise
-
-    logger.debug("Migration up-to-date")
+    with log_context(
+        _logger, logging.DEBUG, f"connection to db {cfg.dsn_with_async_sqlalchemy}"
+    ):
+        engine: AsyncEngine = create_async_engine(
+            cfg.dsn_with_async_sqlalchemy,
+            pool_size=cfg.POSTGRES_MINSIZE,
+            max_overflow=cfg.POSTGRES_MAXSIZE - cfg.POSTGRES_MINSIZE,
+            connect_args={
+                "server_settings": {"application_name": cfg.POSTGRES_CLIENT_NAME}
+            },
+            pool_pre_ping=True,  # https://docs.sqlalchemy.org/en/14/core/pooling.html#dealing-with-disconnects
+            future=True,  # this uses sqlalchemy 2.0 API, shall be removed when sqlalchemy 2.0 is released
+        )
+
+    with log_context(_logger, logging.DEBUG, "migration"):
+        try:
+            await raise_if_migration_not_ready(engine)
+        except Exception:
+            # NOTE: engine must be closed because retry will create a new engine
+            await engine.dispose()
+            raise
 
     app.state.engine = engine
-
-    logger.debug(
+    _logger.debug(
         "Setup engine: %s",
         await get_pg_engine_stateinfo(engine),
     )
 
 
 async def close_db_connection(app: FastAPI) -> None:
-    logger.debug("Disconnecting db ...")
-
-    if engine := app.state.engine:
-        await engine.dispose()
-
-    logger.debug("Disconnected from %s", engine.url)  # pylint: disable=no-member
+    with log_context(_logger, logging.DEBUG, f"db disconnect of {app.state.engine}"):
+        if engine := app.state.engine:
+            await engine.dispose()

services/resource-usage-tracker/openapi.json

@@ -218,13 +218,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "title": "Response Create Credit Transaction V1 Credit Transactions Post",
-                  "type": "object",
-                  "additionalProperties": {
-                    "exclusiveMinimum": true,
-                    "type": "integer",
-                    "minimum": 0
-                  }
+                  "$ref": "#/components/schemas/CreditTransactionCreated"
                 }
               }
             }
@@ -364,6 +358,22 @@
           }
         }
       },
+      "CreditTransactionCreated": {
+        "title": "CreditTransactionCreated",
+        "required": [
+          "credit_transaction_id"
+        ],
+        "type": "object",
+        "properties": {
+          "credit_transaction_id": {
+            "title": "Credit Transaction Id",
+            "exclusiveMinimum": true,
+            "type": "integer",
+            "minimum": 0
+          }
+        },
+        "description": "Response Create Credit Transaction V1 Credit Transactions Post"
+      },
       "HTTPValidationError": {
         "title": "HTTPValidationError",
         "type": "object",

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/api/_resource_tracker.py

@@ -1,9 +1,10 @@
 import logging
-from typing import Annotated, Literal
+from typing import Annotated
 
 from fastapi import APIRouter, Depends, status
 from fastapi_pagination.api import create_page
 from models_library.api_schemas_resource_usage_tracker.credit_transactions import (
+    CreditTransactionCreated,
     WalletTotalCredits,
 )
 from models_library.api_schemas_webserver.resource_usage import (
@@ -20,7 +21,7 @@
     resource_tracker_service_runs,
 )
 
-logger = logging.getLogger(__name__)
+_logger = logging.getLogger(__name__)
 
 
 router = APIRouter()
@@ -74,7 +75,7 @@ async def get_credit_transactions_sum(
 
 @router.post(
     "/credit-transactions",
-    response_model=dict[Literal["credit_transaction_id"], CreditTransactionId],
+    response_model=CreditTransactionCreated,
     summary="Top up credits for specific wallet",
     status_code=status.HTTP_201_CREATED,
 )
@@ -103,5 +104,4 @@ async def get_pricing_plans(
         Depends(resource_tracker_pricing_plans.list_pricing_plans),
     ],
 ):
-
     return pricing_plans

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/resource_tracker_credit_transactions.py

@@ -1,9 +1,9 @@
 from datetime import datetime, timezone
-from decimal import Decimal
 from typing import Annotated
 
 from fastapi import Depends
 from models_library.api_schemas_resource_usage_tracker.credit_transactions import (
+    CreditTransactionCreateBody,
     WalletTotalCredits,
 )
 from models_library.products import ProductName
@@ -13,9 +13,7 @@
     CreditTransactionId,
     CreditTransactionStatus,
 )
-from models_library.users import UserID
 from models_library.wallets import WalletID
-from pydantic import BaseModel
 from servicelib.rabbitmq import RabbitMQClient
 
 from ..api.dependencies import get_repository
@@ -24,17 +22,6 @@
 from ..modules.rabbitmq import get_rabbitmq_client_from_request
 
 
-class CreditTransactionCreateBody(BaseModel):
-    product_name: ProductName
-    wallet_id: WalletID
-    wallet_name: str
-    user_id: UserID
-    user_email: str
-    osparc_credits: Decimal
-    payment_transaction_id: str
-    created_at: datetime
-
-
 async def _sum_credit_transactions_and_publish_to_rabbitmq(
     resource_tracker_repo: ResourceTrackerRepository,
     credit_transaction_create_body: CreditTransactionCreateBody,