♻️ web-server: Refactor products domain (ITISFoundation#7263)

Author: pcrespov

api/specs/web-server/_products.py

@@ -7,21 +7,17 @@
 
 from typing import Annotated
 
-from fastapi import APIRouter, Depends, status
+from fastapi import APIRouter, Depends
 from models_library.api_schemas_webserver.product import (
-    GenerateInvitation,
-    GetCreditPrice,
+    CreditPriceGet,
+    InvitationGenerate,
     InvitationGenerated,
     ProductGet,
     ProductUIGet,
-    UpdateProductTemplate,
 )
 from models_library.generics import Envelope
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.products._handlers import (
-    _ProductsRequestParams,
-    _ProductTemplateParams,
-)
+from simcore_service_webserver.products._rest_schemas import ProductsRequestParams
 
 router = APIRouter(
     prefix=f"/{API_VTAG}",
@@ -33,7 +29,7 @@
 
 @router.get(
     "/credits-price",
-    response_model=Envelope[GetCreditPrice],
+    response_model=Envelope[CreditPriceGet],
 )
 async def get_current_product_price():
     ...
@@ -47,7 +43,7 @@ async def get_current_product_price():
         "po",
     ],
 )
-async def get_product(_params: Annotated[_ProductsRequestParams, Depends()]):
+async def get_product(_params: Annotated[ProductsRequestParams, Depends()]):
     ...
 
 
@@ -59,25 +55,12 @@ async def get_current_product_ui():
     ...
 
 
-@router.put(
-    "/products/{product_name}/templates/{template_id}",
-    status_code=status.HTTP_204_NO_CONTENT,
-    tags=[
-        "po",
-    ],
-)
-async def update_product_template(
-    _params: Annotated[_ProductTemplateParams, Depends()], _body: UpdateProductTemplate
-):
-    ...
-
-
 @router.post(
     "/invitation:generate",
     response_model=Envelope[InvitationGenerated],
     tags=[
         "po",
     ],
 )
-async def generate_invitation(_body: GenerateInvitation):
+async def generate_invitation(_body: InvitationGenerate):
     ...

api/specs/web-server/_statics.py

@@ -8,7 +8,7 @@
 
 from fastapi import APIRouter
 from fastapi.responses import HTMLResponse
-from simcore_service_webserver._constants import INDEX_RESOURCE_NAME
+from simcore_service_webserver.constants import INDEX_RESOURCE_NAME
 from simcore_service_webserver.statics.settings import FrontEndInfoDict
 
 router = APIRouter(

packages/models-library/src/models_library/api_schemas_webserver/product.py

@@ -19,16 +19,20 @@
 from ._base import InputSchema, OutputSchema
 
 
-class GetCreditPrice(OutputSchema):
+class CreditPriceGet(OutputSchema):
     product_name: str
     usd_per_credit: Annotated[
-        NonNegativeDecimal,
-        PlainSerializer(float, return_type=NonNegativeFloat, when_used="json"),
-    ] | None = Field(
-        ...,
-        description="Price of a credit in USD. "
-        "If None, then this product's price is UNDEFINED",
-    )
+        Annotated[
+            NonNegativeDecimal,
+            PlainSerializer(float, return_type=NonNegativeFloat, when_used="json"),
+        ]
+        | None,
+        Field(
+            description="Price of a credit in USD. "
+            "If None, then this product's price is UNDEFINED",
+        ),
+    ]
+
     min_payment_amount_usd: Annotated[
         NonNegativeInt | None,
         Field(
@@ -61,15 +65,11 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
     )
 
 
-class GetProductTemplate(OutputSchema):
+class ProductTemplateGet(OutputSchema):
     id_: Annotated[IDStr, Field(alias="id")]
     content: str
 
 
-class UpdateProductTemplate(InputSchema):
-    content: str
-
-
 class ProductGet(OutputSchema):
     name: ProductName
     display_name: str
@@ -92,7 +92,7 @@ class ProductGet(OutputSchema):
     credits_per_usd: NonNegativeDecimal | None
 
     templates: Annotated[
-        list[GetProductTemplate],
+        list[ProductTemplateGet],
         Field(
             description="List of templates available to this product for communications (e.g. emails, sms, etc)",
             default_factory=list,
@@ -111,7 +111,7 @@ class ProductUIGet(OutputSchema):
 ExtraCreditsUsdRangeInt: TypeAlias = Annotated[int, Field(ge=0, lt=500)]
 
 
-class GenerateInvitation(InputSchema):
+class InvitationGenerate(InputSchema):
     guest: LowerCaseEmailStr
     trial_account_days: PositiveInt | None = None
     extra_credits_in_usd: ExtraCreditsUsdRangeInt | None = None

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

@@ -59,7 +59,7 @@ async def get_product_latest_stripe_info(
         )
     ).fetchone()
     if row is None:
-        msg = "No product Stripe info defined in database"
+        msg = f"Required Stripe information missing from product {product_name=}"
         raise ValueError(msg)
     return (row.stripe_price_id, row.stripe_tax_rate_id)
 

packages/pytest-simcore/src/pytest_simcore/helpers/webserver_login.py

@@ -11,7 +11,7 @@
 from simcore_service_webserver.login._constants import MSG_LOGGED_IN
 from simcore_service_webserver.login._registration import create_invitation_token
 from simcore_service_webserver.login.storage import AsyncpgStorage, get_plugin_storage
-from simcore_service_webserver.products.api import list_products
+from simcore_service_webserver.products.products_service import list_products
 from simcore_service_webserver.security.api import clean_auth_policy_cache
 from yarl import URL
 

services/api-server/src/simcore_service_api_server/models/schemas/model_adapter.py

@@ -14,7 +14,7 @@
     LicensedItemCheckoutRpcGet as _LicensedItemCheckoutRpcGet,
 )
 from models_library.api_schemas_webserver.product import (
-    GetCreditPrice as _GetCreditPrice,
+    CreditPriceGet as _GetCreditPrice,
 )
 from models_library.api_schemas_webserver.resource_usage import (
     PricingUnitGet as _PricingUnitGet,

services/api-server/tests/unit/test_credits.py

@@ -2,7 +2,7 @@
 
 from fastapi import status
 from httpx import AsyncClient, BasicAuth
-from models_library.api_schemas_webserver.product import GetCreditPrice
+from models_library.api_schemas_webserver.product import CreditPriceGet
 from pytest_simcore.helpers.httpx_calls_capture_models import CreateRespxMockCallback
 from simcore_service_api_server._meta import API_VTAG
 
@@ -23,4 +23,4 @@ async def test_get_credits_price(
 
     response = await client.get(f"{API_VTAG}/credits/price", auth=auth)
     assert response.status_code == status.HTTP_200_OK
-    _ = GetCreditPrice.model_validate(response.json())
+    _ = CreditPriceGet.model_validate(response.json())

services/web/server/src/simcore_service_webserver/activity/settings.py

@@ -1,7 +1,7 @@
 from aiohttp import web
 from settings_library.prometheus import PrometheusSettings
 
-from .._constants import APP_SETTINGS_KEY
+from ..constants import APP_SETTINGS_KEY
 
 
 def get_plugin_settings(app: web.Application) -> PrometheusSettings:

services/web/server/src/simcore_service_webserver/announcements/_handlers.py

@@ -3,7 +3,7 @@
 from aiohttp import web
 
 from .._meta import api_version_prefix
-from ..products.api import get_product_name
+from ..products import products_web
 from ..utils_aiohttp import envelope_json_response
 from . import _api
 from ._models import Announcement
@@ -14,7 +14,7 @@
 @routes.get(f"/{api_version_prefix}/announcements", name="list_announcements")
 async def list_announcements(request: web.Request) -> web.Response:
     """Returns non-expired announcements for current product"""
-    product_name = get_product_name(request)
+    product_name = products_web.get_product_name(request)
     announcements: list[Announcement] = await _api.list_announcements(
         request.app, product_name=product_name
     )

services/web/server/src/simcore_service_webserver/announcements/plugin.py

@@ -7,7 +7,7 @@
 from aiohttp import web
 from servicelib.aiohttp.application_setup import ModuleCategory, app_module_setup
 
-from .._constants import APP_SETTINGS_KEY
+from ..constants import APP_SETTINGS_KEY
 from ..products.plugin import setup_products
 from ..redis import setup_redis
 from . import _handlers