🎨 improvements: return user email in licensed items, error msg, expose pricing plans 🗃️

api/specs/web-server/_resource_usage.py

@@ -21,6 +21,7 @@
     CreatePricingPlanBodyParams,
     CreatePricingUnitBodyParams,
     PricingPlanAdminGet,
+    PricingPlanGet,
     PricingPlanToServiceAdminGet,
     PricingUnitAdminGet,
     PricingUnitGet,
@@ -29,15 +30,16 @@
     UpdatePricingUnitBodyParams,
 )
 from models_library.generics import Envelope
+from models_library.rest_pagination import Page, PageQueryParameters
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.resource_usage._pricing_plans_admin_handlers import (
+from simcore_service_webserver.resource_usage._pricing_plans_admin_rest import (
     PricingPlanGetPathParams,
     PricingUnitGetPathParams,
 )
-from simcore_service_webserver.resource_usage._pricing_plans_handlers import (
+from simcore_service_webserver.resource_usage._pricing_plans_rest import (
     PricingPlanUnitGetPathParams,
 )
-from simcore_service_webserver.resource_usage._service_runs_handlers import (
+from simcore_service_webserver.resource_usage._service_runs_rest import (
     ServicesAggregatedUsagesListQueryParams,
     ServicesResourceUsagesListQueryParams,
     ServicesResourceUsagesReportQueryParams,
@@ -48,7 +50,7 @@
 
 @router.get(
     "/services/-/resource-usages",
-    response_model=Envelope[list[ServiceRunGet]],
+    response_model=Page[ServiceRunGet],
     summary="Retrieve finished and currently running user services"
     " (user and product are taken from context, optionally wallet_id parameter might be provided).",
     tags=["usage"],
@@ -61,7 +63,7 @@ async def list_resource_usage_services(
 
 @router.get(
     "/services/-/aggregated-usages",
-    response_model=Envelope[list[OsparcCreditsAggregatedByServiceGet]],
+    response_model=Page[OsparcCreditsAggregatedByServiceGet],
     summary="Used credits based on aggregate by type, currently supported `services`"
     ". (user and product are taken from context, optionally wallet_id parameter might be provided).",
     tags=["usage"],
@@ -93,7 +95,6 @@ async def export_resource_usage_services(
 @router.get(
     "/pricing-plans/{pricing_plan_id}/pricing-units/{pricing_unit_id}",
     response_model=Envelope[PricingUnitGet],
-    summary="Retrieve detail information about pricing unit",
     tags=["pricing-plans"],
 )
 async def get_pricing_plan_unit(
@@ -102,27 +103,50 @@ async def get_pricing_plan_unit(
     ...
 
 
+@router.get(
+    "/pricing-plans",
+    response_model=Page[PricingPlanGet],
+    tags=["pricing-plans"],
+    description="To keep the listing lightweight, the pricingUnits field is None.",
+)
+async def list_pricing_plans(
+    _query: Annotated[as_query(PageQueryParameters), Depends()]
+):
+    ...
+
+
+@router.get(
+    "/pricing-plans/{pricing_plan_id}",
+    response_model=Envelope[PricingPlanGet],
+    tags=["pricing-plans"],
+)
+async def get_pricing_plan(
+    _path: Annotated[PricingPlanGetPathParams, Depends()],
+):
+    ...
+
+
 ## Pricing plans for Admin panel
 
 
 @router.get(
     "/admin/pricing-plans",
-    response_model=Envelope[list[PricingPlanAdminGet]],
-    summary="List pricing plans",
+    response_model=Page[PricingPlanAdminGet],
     tags=["admin"],
     description="To keep the listing lightweight, the pricingUnits field is None.",
 )
-async def list_pricing_plans():
+async def list_pricing_plans_for_admin_user(
+    _query: Annotated[as_query(PageQueryParameters), Depends()]
+):
     ...
 
 
 @router.get(
     "/admin/pricing-plans/{pricing_plan_id}",
     response_model=Envelope[PricingPlanAdminGet],
-    summary="Retrieve detail information about pricing plan",
     tags=["admin"],
 )
-async def get_pricing_plan(
+async def get_pricing_plan_for_admin_user(
     _path: Annotated[PricingPlanGetPathParams, Depends()],
 ):
     ...
@@ -131,7 +155,6 @@ async def get_pricing_plan(
 @router.post(
     "/admin/pricing-plans",
     response_model=Envelope[PricingPlanAdminGet],
-    summary="Create pricing plan",
     tags=["admin"],
 )
 async def create_pricing_plan(
@@ -143,7 +166,6 @@ async def create_pricing_plan(
 @router.put(
     "/admin/pricing-plans/{pricing_plan_id}",
     response_model=Envelope[PricingPlanAdminGet],
-    summary="Update detail information about pricing plan",
     tags=["admin"],
 )
 async def update_pricing_plan(
@@ -159,7 +181,6 @@ async def update_pricing_plan(
 @router.get(
     "/admin/pricing-plans/{pricing_plan_id}/pricing-units/{pricing_unit_id}",
     response_model=Envelope[PricingUnitAdminGet],
-    summary="Retrieve detail information about pricing unit",
     tags=["admin"],
 )
 async def get_pricing_unit(
@@ -171,7 +192,6 @@ async def get_pricing_unit(
 @router.post(
     "/admin/pricing-plans/{pricing_plan_id}/pricing-units",
     response_model=Envelope[PricingUnitAdminGet],
-    summary="Create pricing unit",
     tags=["admin"],
 )
 async def create_pricing_unit(
@@ -184,7 +204,6 @@ async def create_pricing_unit(
 @router.put(
     "/admin/pricing-plans/{pricing_plan_id}/pricing-units/{pricing_unit_id}",
     response_model=Envelope[PricingUnitAdminGet],
-    summary="Update detail information about pricing plan",
     tags=["admin"],
 )
 async def update_pricing_unit(
@@ -200,7 +219,6 @@ async def update_pricing_unit(
 @router.get(
     "/admin/pricing-plans/{pricing_plan_id}/billable-services",
     response_model=Envelope[list[PricingPlanToServiceAdminGet]],
-    summary="List services that are connected to the provided pricing plan",
     tags=["admin"],
 )
 async def list_connected_services_to_pricing_plan(
@@ -212,7 +230,6 @@ async def list_connected_services_to_pricing_plan(
 @router.post(
     "/admin/pricing-plans/{pricing_plan_id}/billable-services",
     response_model=Envelope[PricingPlanToServiceAdminGet],
-    summary="Connect service with pricing plan",
     tags=["admin"],
 )
 async def connect_service_to_pricing_plan(

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

@@ -17,6 +17,7 @@ class LicensedItemCheckoutGet(BaseModel):
     licensed_item_id: LicensedItemID
     wallet_id: WalletID
     user_id: UserID
+    user_email: str
     product_name: ProductName
     service_run_id: ServiceRunID
     started_at: datetime
@@ -31,6 +32,7 @@ class LicensedItemCheckoutGet(BaseModel):
                     "licensed_item_id": "303942ef-6d31-4ba8-afbe-dbb1fce2a953",
                     "wallet_id": 1,
                     "user_id": 1,
+                    "user_email": "[email protected]",
                     "product_name": "osparc",
                     "service_run_id": "run_1",
                     "started_at": "2023-01-11 13:11:47.293595",

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

@@ -25,6 +25,7 @@ class LicensedItemPurchaseGet(BaseModel):
     expire_at: datetime
     num_of_seats: int
     purchased_by_user: UserID
+    user_email: str
     purchased_at: datetime
     modified: datetime
 
@@ -43,6 +44,7 @@ class LicensedItemPurchaseGet(BaseModel):
                     "expire_at": "2023-01-11 13:11:47.293595",
                     "num_of_seats": 1,
                     "purchased_by_user": 1,
+                    "user_email": "[email protected]",
                     "purchased_at": "2023-01-11 13:11:47.293595",
                     "modified": "2023-01-11 13:11:47.293595",
                 }

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

@@ -1,7 +1,8 @@
 from datetime import datetime
 from decimal import Decimal
+from typing import NamedTuple
 
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, PositiveInt
 
 from ..resource_tracker import (
     HardwareInfo,
@@ -76,6 +77,11 @@ class PricingPlanGet(BaseModel):
     )
 
 
+class PricingPlanPage(NamedTuple):
+    items: list[PricingPlanGet]
+    total: PositiveInt
+
+
 class PricingPlanToServiceGet(BaseModel):
     pricing_plan_id: PricingPlanId
     service_key: ServiceKey

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

@@ -1,6 +1,7 @@
 from datetime import datetime
 from typing import NamedTuple
 
+from models_library.emails import LowerCaseEmailStr
 from pydantic import BaseModel, ConfigDict, PositiveInt
 
 from ..licensed_items import LicensedItemID
@@ -53,6 +54,7 @@ class LicensedItemCheckoutRestGet(OutputSchema):
     licensed_item_id: LicensedItemID
     wallet_id: WalletID
     user_id: UserID
+    user_email: LowerCaseEmailStr
     product_name: ProductName
     started_at: datetime
     stopped_at: datetime | None

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

@@ -2,6 +2,7 @@
 from decimal import Decimal
 from typing import NamedTuple
 
+from models_library.emails import LowerCaseEmailStr
 from pydantic import PositiveInt
 
 from ..licensed_items import LicensedItemID
@@ -24,6 +25,7 @@ class LicensedItemPurchaseGet(OutputSchema):
     expire_at: datetime
     num_of_seats: int
     purchased_by_user: UserID
+    user_email: LowerCaseEmailStr
     purchased_at: datetime
     modified_at: datetime
 

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

@@ -60,7 +60,7 @@ class PricingPlanGet(OutputSchema):
     classification: PricingPlanClassification
     created_at: datetime
     pricing_plan_key: str
-    pricing_units: list[PricingUnitGet]
+    pricing_units: list[PricingUnitGet] | None
     is_active: bool
 
 
@@ -78,7 +78,7 @@ class PricingPlanAdminGet(OutputSchema):
     classification: PricingPlanClassification
     created_at: datetime
     pricing_plan_key: str
-    pricing_units: list[PricingUnitGet] | None
+    pricing_units: list[PricingUnitAdminGet] | None
     is_active: bool
 
 

packages/postgres-database/src/simcore_postgres_database/migration/versions/5f88b513cd4c_add_user_email_col_to_purchases.py

@@ -0,0 +1,30 @@
+"""add user email col to purchases
+
+Revision ID: 5f88b513cd4c
+Revises: ecd4eadaa781
+Create Date: 2025-01-22 15:08:17.729337+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "5f88b513cd4c"
+down_revision = "ecd4eadaa781"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column(
+        "resource_tracker_licensed_items_purchases",
+        sa.Column("user_email", sa.String(), nullable=True),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("resource_tracker_licensed_items_purchases", "user_email")
+    # ### end Alembic commands ###

packages/postgres-database/src/simcore_postgres_database/models/resource_tracker_licensed_items_purchases.py

@@ -72,6 +72,11 @@
         sa.BigInteger,
         nullable=False,
     ),
+    sa.Column(
+        "user_email",
+        sa.String,
+        nullable=True,
+    ),
     sa.Column(
         "purchased_at",
         sa.DateTime(timezone=True),

packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/resource_usage_tracker/pricing_plans.py

@@ -6,6 +6,7 @@
 )
 from models_library.api_schemas_resource_usage_tracker.pricing_plans import (
     PricingPlanGet,
+    PricingPlanPage,
     PricingPlanToServiceGet,
 )
 from models_library.products import ProductName
@@ -52,14 +53,21 @@ async def list_pricing_plans(
     rabbitmq_rpc_client: RabbitMQRPCClient,
     *,
     product_name: ProductName,
-) -> list[PricingPlanGet]:
-    result: PricingPlanGet = await rabbitmq_rpc_client.request(
+    exclude_inactive: bool = True,
+    # pagination
+    offset: int = 0,
+    limit: int = 20,
+) -> PricingPlanPage:
+    result = await rabbitmq_rpc_client.request(
         RESOURCE_USAGE_TRACKER_RPC_NAMESPACE,
         _RPC_METHOD_NAME_ADAPTER.validate_python("list_pricing_plans"),
         product_name=product_name,
+        exclude_inactive=exclude_inactive,
+        offset=offset,
+        limit=limit,
         timeout_s=_DEFAULT_TIMEOUT_S,
     )
-    assert isinstance(result, list)  # nosec
+    assert isinstance(result, PricingPlanPage)  # nosec
     return result
 
 

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/api/rpc/_pricing_plans.py

@@ -1,6 +1,7 @@
 from fastapi import FastAPI
 from models_library.api_schemas_resource_usage_tracker.pricing_plans import (
     PricingPlanGet,
+    PricingPlanPage,
     PricingPlanToServiceGet,
     PricingUnitGet,
 )
@@ -43,10 +44,17 @@ async def list_pricing_plans(
     app: FastAPI,
     *,
     product_name: ProductName,
-) -> list[PricingPlanGet]:
+    exclude_inactive: bool,
+    # pagination
+    offset: int,
+    limit: int,
+) -> PricingPlanPage:
     return await pricing_plans.list_pricing_plans_by_product(
-        product_name=product_name,
         db_engine=app.state.engine,
+        product_name=product_name,
+        exclude_inactive=exclude_inactive,
+        offset=offset,
+        limit=limit,
     )
 
 

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/models/licensed_items_purchases.py

@@ -1,6 +1,7 @@
 from datetime import datetime
 from decimal import Decimal
 
+from models_library.emails import LowerCaseEmailStr
 from models_library.licensed_items import LicensedItemID
 from models_library.products import ProductName
 from models_library.resource_tracker import PricingUnitCostId
@@ -24,6 +25,7 @@ class LicensedItemsPurchasesDB(BaseModel):
     expire_at: datetime
     num_of_seats: int
     purchased_by_user: UserID
+    user_email: LowerCaseEmailStr
     purchased_at: datetime
     modified: datetime
 
@@ -41,6 +43,7 @@ class CreateLicensedItemsPurchasesDB(BaseModel):
     expire_at: datetime
     num_of_seats: int
     purchased_by_user: UserID
+    user_email: LowerCaseEmailStr
     purchased_at: datetime
 
     model_config = ConfigDict(from_attributes=True)