♻️🎨 web-server: enhances product domain (ITISFoundation#7294)

Author: pcrespov

api/specs/web-server/_products.py

@@ -8,7 +8,7 @@
 from typing import Annotated
 
 from fastapi import APIRouter, Depends
-from models_library.api_schemas_webserver.product import (
+from models_library.api_schemas_webserver.products import (
     CreditPriceGet,
     InvitationGenerate,
     InvitationGenerated,
@@ -17,7 +17,9 @@
 )
 from models_library.generics import Envelope
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.products._rest_schemas import ProductsRequestParams
+from simcore_service_webserver.products._controller.rest_schemas import (
+    ProductsRequestParams,
+)
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
@@ -31,8 +33,7 @@
     "/credits-price",
     response_model=Envelope[CreditPriceGet],
 )
-async def get_current_product_price():
-    ...
+async def get_current_product_price(): ...
 
 
 @router.get(
@@ -43,16 +44,14 @@ async def get_current_product_price():
         "po",
     ],
 )
-async def get_product(_params: Annotated[ProductsRequestParams, Depends()]):
-    ...
+async def get_product(_params: Annotated[ProductsRequestParams, Depends()]): ...
 
 
 @router.get(
     "/products/current/ui",
     response_model=Envelope[ProductUIGet],
 )
-async def get_current_product_ui():
-    ...
+async def get_current_product_ui(): ...
 
 
 @router.post(
@@ -62,5 +61,4 @@ async def get_current_product_ui():
         "po",
     ],
 )
-async def generate_invitation(_body: InvitationGenerate):
-    ...
+async def generate_invitation(_body: InvitationGenerate): ...

packages/models-library/src/models_library/api_schemas_webserver/product.py renamed to packages/models-library/src/models_library/api_schemas_webserver/products.py

@@ -1,8 +1,10 @@
 from datetime import datetime
+from decimal import Decimal
 from typing import Annotated, Any, TypeAlias
 
 from common_library.basic_types import DEFAULT_FACTORY
 from pydantic import (
+    BaseModel,
     ConfigDict,
     Field,
     HttpUrl,
@@ -19,6 +21,28 @@
 from ._base import InputSchema, OutputSchema
 
 
+class CreditResultRpcGet(BaseModel):
+    product_name: ProductName
+    credit_amount: Decimal
+
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "examples": [
+                    {
+                        "product_name": "s4l",
+                        "credit_amount": Decimal("15.5"),  # type: ignore[dict-item]
+                    },
+                ]
+            }
+        )
+
+    model_config = ConfigDict(
+        json_schema_extra=_update_json_schema_extra,
+    )
+
+
 class CreditPriceGet(OutputSchema):
     product_name: str
     usd_per_credit: Annotated[

packages/models-library/src/models_library/products.py

@@ -1,36 +1,5 @@
-from decimal import Decimal
 from typing import TypeAlias
 
-from pydantic import BaseModel, ConfigDict, Field
-
 ProductName: TypeAlias = str
 StripePriceID: TypeAlias = str
 StripeTaxRateID: TypeAlias = str
-
-
-class CreditResultGet(BaseModel):
-    product_name: ProductName
-    credit_amount: Decimal = Field(..., description="")
-
-    model_config = ConfigDict(
-        json_schema_extra={
-            "examples": [
-                {"product_name": "s4l", "credit_amount": Decimal(15.5)},  # type: ignore[dict-item]
-            ]
-        }
-    )
-
-
-class ProductStripeInfoGet(BaseModel):
-    stripe_price_id: StripePriceID
-    stripe_tax_rate_id: StripeTaxRateID
-    model_config = ConfigDict(
-        json_schema_extra={
-            "examples": [
-                {
-                    "stripe_price_id": "stripe-price-id",
-                    "stripe_tax_rate_id": "stripe-tax-rate-id",
-                },
-            ]
-        }
-    )

packages/postgres-database/src/simcore_postgres_database/errors.py renamed to packages/postgres-database/src/simcore_postgres_database/aiopg_errors.py

@@ -1,25 +1,32 @@
-""" aiopg errors
+"""aiopg errors
 
-    StandardError
-    |__ Warning
-    |__ Error
-        |__ InterfaceError
-        |__ DatabaseError
-            |__ DataError
-            |__ OperationalError
-            |__ IntegrityError
-            |__ InternalError
-            |__ ProgrammingError
-            |__ NotSupportedError
+WARNING: these errors are not raised by asyncpg. Therefore all code using new sqlalchemy.ext.asyncio
+         MUST use instead import sqlalchemy.exc exceptions!!!!
 
-    - aiopg reuses DBAPI exceptions
-        SEE https://aiopg.readthedocs.io/en/stable/core.html?highlight=Exception#exceptions
-        SEE http://initd.org/psycopg/docs/module.html#dbapi-exceptions
-        SEE https://www.postgresql.org/docs/current/errcodes-appendix.html
+StandardError
+|__ Warning
+|__ Error
+    |__ InterfaceError
+    |__ DatabaseError
+        |__ DataError
+        |__ OperationalError
+        |__ IntegrityError
+        |__ InternalError
+        |__ ProgrammingError
+        |__ NotSupportedError
+
+- aiopg reuses DBAPI exceptions
+    SEE https://aiopg.readthedocs.io/en/stable/core.html?highlight=Exception#exceptions
+    SEE http://initd.org/psycopg/docs/module.html#dbapi-exceptions
+    SEE https://www.postgresql.org/docs/current/errcodes-appendix.html
 """
+
 # NOTE: psycopg2.errors are created dynamically
 # pylint: disable=no-name-in-module
-from psycopg2 import DatabaseError, DataError
+from psycopg2 import (
+    DatabaseError,
+    DataError,
+)
 from psycopg2 import Error as DBAPIError
 from psycopg2 import (
     IntegrityError,

packages/postgres-database/src/simcore_postgres_database/utils_payments.py

@@ -8,7 +8,7 @@
 from aiopg.sa.connection import SAConnection
 from aiopg.sa.result import ResultProxy, RowProxy
 
-from . import errors
+from . import aiopg_errors
 from .models.payments_transactions import PaymentTransactionState, payments_transactions
 
 _logger = logging.getLogger(__name__)
@@ -29,16 +29,13 @@ def __bool__(self):
         return False
 
 
-class PaymentAlreadyExists(PaymentFailure):
-    ...
+class PaymentAlreadyExists(PaymentFailure): ...
 
 
-class PaymentNotFound(PaymentFailure):
-    ...
+class PaymentNotFound(PaymentFailure): ...
 
 
-class PaymentAlreadyAcked(PaymentFailure):
-    ...
+class PaymentAlreadyAcked(PaymentFailure): ...
 
 
 async def insert_init_payment_transaction(
@@ -69,7 +66,7 @@ async def insert_init_payment_transaction(
                 initiated_at=initiated_at,
             )
         )
-    except errors.UniqueViolation:
+    except aiopg_errors.UniqueViolation:
         return PaymentAlreadyExists(payment_id)
 
     return payment_id

packages/postgres-database/src/simcore_postgres_database/utils_products.py

@@ -1,20 +1,19 @@
-""" Common functions to access products table
-
-"""
-
-import warnings
+"""Common functions to access products table"""
 
 import sqlalchemy as sa
+from sqlalchemy.ext.asyncio import AsyncConnection
 
-from ._protocols import AiopgConnection, DBConnection
 from .models.groups import GroupType, groups
 from .models.products import products
 
 # NOTE: outside this module, use instead packages/models-library/src/models_library/users.py
 _GroupID = int
 
 
-async def get_default_product_name(conn: DBConnection) -> str:
+class EmptyProductsError(ValueError): ...
+
+
+async def get_default_product_name(conn: AsyncConnection) -> str:
     """The first row in the table is considered as the default product
 
     :: raises ValueError if undefined
@@ -23,23 +22,25 @@ async def get_default_product_name(conn: DBConnection) -> str:
         sa.select(products.c.name).order_by(products.c.priority)
     )
     if not product_name:
-        msg = "No product defined in database"
-        raise ValueError(msg)
+        msg = "No product was defined in database. Upon construction, at least one product is added but there are none."
+        raise EmptyProductsError(msg)
 
     assert isinstance(product_name, str)  # nosec
     return product_name
 
 
-async def get_product_group_id(
-    connection: DBConnection, product_name: str
+async def get_product_group_id_or_none(
+    connection: AsyncConnection, product_name: str
 ) -> _GroupID | None:
     group_id = await connection.scalar(
         sa.select(products.c.group_id).where(products.c.name == product_name)
     )
     return None if group_id is None else _GroupID(group_id)
 
 
-async def execute_get_or_create_product_group(conn, product_name: str) -> int:
+async def get_or_create_product_group(
+    conn: AsyncConnection, product_name: str
+) -> _GroupID:
     #
     # NOTE: Separated so it can be used in asyncpg and aiopg environs while both
     #       coexist
@@ -70,23 +71,3 @@ async def execute_get_or_create_product_group(conn, product_name: str) -> int:
         )
 
     return group_id
-
-
-async def get_or_create_product_group(
-    connection: AiopgConnection, product_name: str
-) -> _GroupID:
-    """
-    Returns group_id of a product. Creates it if undefined
-    """
-    warnings.warn(
-        f"{__name__}.get_or_create_product_group uses aiopg which has been deprecated in this repo. Please use the asyncpg equivalent version instead"
-        "See https://github.com/ITISFoundation/osparc-simcore/issues/4529",
-        DeprecationWarning,
-        stacklevel=1,
-    )
-
-    async with connection.begin():
-        group_id = await execute_get_or_create_product_group(
-            connection, product_name=product_name
-        )
-        return _GroupID(group_id)

packages/postgres-database/src/simcore_postgres_database/utils_products_prices.py

@@ -2,7 +2,7 @@
 from typing import NamedTuple, TypeAlias
 
 import sqlalchemy as sa
-from aiopg.sa.connection import SAConnection
+from sqlalchemy.ext.asyncio import AsyncConnection
 
 from .constants import QUANTIZE_EXP_ARG
 from .models.products_prices import products_prices
@@ -17,9 +17,9 @@ class ProductPriceInfo(NamedTuple):
 
 
 async def get_product_latest_price_info_or_none(
-    conn: SAConnection, product_name: str
+    conn: AsyncConnection, product_name: str
 ) -> ProductPriceInfo | None:
-    """None menans the product is not billable"""
+    """If the product is not billable, it returns None"""
     # newest price of a product
     result = await conn.execute(
         sa.select(
@@ -30,7 +30,7 @@ async def get_product_latest_price_info_or_none(
         .order_by(sa.desc(products_prices.c.valid_from))
         .limit(1)
     )
-    row = await result.first()
+    row = result.one_or_none()
 
     if row and row.usd_per_credit is not None:
         assert row.min_payment_amount_usd is not None  # nosec
@@ -43,27 +43,24 @@ async def get_product_latest_price_info_or_none(
     return None
 
 
-async def get_product_latest_stripe_info(
-    conn: SAConnection, product_name: str
-) -> tuple[StripePriceID, StripeTaxRateID]:
+async def get_product_latest_stripe_info_or_none(
+    conn: AsyncConnection, product_name: str
+) -> tuple[StripePriceID, StripeTaxRateID] | None:
     # Stripe info of a product for latest price
-    row = await (
-        await conn.execute(
-            sa.select(
-                products_prices.c.stripe_price_id,
-                products_prices.c.stripe_tax_rate_id,
-            )
-            .where(products_prices.c.product_name == product_name)
-            .order_by(sa.desc(products_prices.c.valid_from))
-            .limit(1)
+    result = await conn.execute(
+        sa.select(
+            products_prices.c.stripe_price_id,
+            products_prices.c.stripe_tax_rate_id,
         )
-    ).fetchone()
-    if row is None:
-        msg = f"Required Stripe information missing from product {product_name=}"
-        raise ValueError(msg)
-    return (row.stripe_price_id, row.stripe_tax_rate_id)
+        .where(products_prices.c.product_name == product_name)
+        .order_by(sa.desc(products_prices.c.valid_from))
+        .limit(1)
+    )
+
+    row = result.one_or_none()
+    return (row.stripe_price_id, row.stripe_tax_rate_id) if row else None
 
 
-async def is_payment_enabled(conn: SAConnection, product_name: str) -> bool:
+async def is_payment_enabled(conn: AsyncConnection, product_name: str) -> bool:
     p = await get_product_latest_price_info_or_none(conn, product_name=product_name)
     return bool(p)  # zero or None is disabled