🎨 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,
@@ -102,6 +103,29 @@ async def get_pricing_plan_unit(
     ...
 
 
+@router.get(
+    "/pricing-plans",
+    response_model=Envelope[list[PricingPlanGet]],
+    summary="List pricing plans",
+    tags=["pricing-plans"],
+    description="To keep the listing lightweight, the pricingUnits field is None.",
+)
+async def list_pricing_plans():
+    ...
+
+
+@router.get(
+    "/pricing-plans/{pricing_plan_id}",
+    response_model=Envelope[PricingPlanGet],
+    summary="Retrieve detail information about pricing plan",
+    tags=["pricing-plans"],
+)
+async def get_pricing_plan(
+    _path: Annotated[PricingPlanGetPathParams, Depends()],
+):
+    ...
+
+
 ## Pricing plans for Admin panel
 
 
@@ -112,7 +136,7 @@ async def get_pricing_plan_unit(
     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():
     ...
 
 
@@ -122,7 +146,7 @@ async def list_pricing_plans():
     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()],
 ):
     ...

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_webserver/licensed_items_checkouts.py

@@ -53,6 +53,7 @@ class LicensedItemCheckoutRestGet(OutputSchema):
     licensed_item_id: LicensedItemID
     wallet_id: WalletID
     user_id: UserID
+    user_email: str
     product_name: ProductName
     started_at: datetime
     stopped_at: datetime | None

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

@@ -24,6 +24,7 @@ class LicensedItemPurchaseGet(OutputSchema):
     expire_at: datetime
     num_of_seats: int
     purchased_by_user: UserID
+    user_email: str
     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
 
 

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),

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

@@ -24,6 +24,7 @@ class LicensedItemsPurchasesDB(BaseModel):
     expire_at: datetime
     num_of_seats: int
     purchased_by_user: UserID
+    user_email: str
     purchased_at: datetime
     modified: datetime
 
@@ -41,6 +42,7 @@ class CreateLicensedItemsPurchasesDB(BaseModel):
     expire_at: datetime
     num_of_seats: int
     purchased_by_user: UserID
+    user_email: str
     purchased_at: datetime
 
     model_config = ConfigDict(from_attributes=True)

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

@@ -81,6 +81,7 @@ async def _close_unhealthy_service(
     service_run_id: ServiceRunID,
     base_start_timestamp: datetime,
 ):
+
     # 1. Close the service_run
     update_service_run_stopped_at = ServiceRunStoppedAtUpdate(
         service_run_id=service_run_id,
@@ -106,21 +107,39 @@ async def _close_unhealthy_service(
             running_service.last_heartbeat_at,
             running_service.pricing_unit_cost,
         )
+        _transaction_status = (
+            CreditTransactionStatus.NOT_BILLED
+            if running_service.service_type
+            == ResourceTrackerServiceType.COMPUTATIONAL_SERVICE
+            else CreditTransactionStatus.BILLED
+        )
         update_credit_transaction = CreditTransactionCreditsAndStatusUpdate(
             service_run_id=service_run_id,
             osparc_credits=make_negative(computed_credits),
-            transaction_status=(
-                CreditTransactionStatus.NOT_BILLED
-                if running_service.service_type
-                == ResourceTrackerServiceType.COMPUTATIONAL_SERVICE
-                else CreditTransactionStatus.BILLED
-            ),
+            transaction_status=_transaction_status,
         )
         await credit_transactions_db.update_credit_transaction_credits_and_status(
             db_engine, data=update_credit_transaction
         )
 
-    # 3. Release license seats in case some were checked out but not properly released.
+        # 3. If the credit transaction status is considered "NOT_BILLED", this might return
+        # the wallet to positive numbers. If, in the meantime, some transactions were marked as DEBT,
+        # we need to update them back to the BILLED state.
+        if _transaction_status == CreditTransactionStatus.NOT_BILLED:
+            wallet_total_credits = await credit_transactions_db.sum_wallet_credits(
+                db_engine,
+                product_name=running_service.product_name,
+                wallet_id=running_service.wallet_id,
+            )
+            if wallet_total_credits.available_osparc_credits >= 0:
+                await credit_transactions_db.batch_update_credit_transaction_status_for_in_debt_transactions(
+                    db_engine,
+                    project_id=None,
+                    wallet_id=running_service.wallet_id,
+                    transaction_status=CreditTransactionStatus.BILLED,
+                )
+
+    # 4. Release license seats in case some were checked out but not properly released.
     await licensed_items_checkouts_db.force_release_license_seats_by_run_id(
         db_engine, service_run_id=service_run_id
     )

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

@@ -60,6 +60,7 @@ async def list_licensed_items_checkouts(
                 licensed_item_id=licensed_item_checkout_db.licensed_item_id,
                 wallet_id=licensed_item_checkout_db.wallet_id,
                 user_id=licensed_item_checkout_db.user_id,
+                user_email=licensed_item_checkout_db.user_email,
                 product_name=licensed_item_checkout_db.product_name,
                 service_run_id=licensed_item_checkout_db.service_run_id,
                 started_at=licensed_item_checkout_db.started_at,
@@ -90,6 +91,7 @@ async def get_licensed_item_checkout(
         licensed_item_id=licensed_item_checkout_db.licensed_item_id,
         wallet_id=licensed_item_checkout_db.wallet_id,
         user_id=licensed_item_checkout_db.user_id,
+        user_email=licensed_item_checkout_db.user_email,
         product_name=licensed_item_checkout_db.product_name,
         service_run_id=licensed_item_checkout_db.service_run_id,
         started_at=licensed_item_checkout_db.started_at,
@@ -171,6 +173,7 @@ async def checkout_licensed_item(
         licensed_item_id=licensed_item_checkout_db.licensed_item_id,
         wallet_id=licensed_item_checkout_db.wallet_id,
         user_id=licensed_item_checkout_db.user_id,
+        user_email=licensed_item_checkout_db.user_email,
         product_name=licensed_item_checkout_db.product_name,
         service_run_id=licensed_item_checkout_db.service_run_id,
         started_at=licensed_item_checkout_db.started_at,
@@ -200,6 +203,7 @@ async def release_licensed_item(
         licensed_item_id=licensed_item_checkout_db.licensed_item_id,
         wallet_id=licensed_item_checkout_db.wallet_id,
         user_id=licensed_item_checkout_db.user_id,
+        user_email=licensed_item_checkout_db.user_email,
         product_name=licensed_item_checkout_db.product_name,
         service_run_id=licensed_item_checkout_db.service_run_id,
         started_at=licensed_item_checkout_db.started_at,

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

@@ -62,6 +62,7 @@ async def list_licensed_items_purchases(
                 expire_at=licensed_item_purchase_db.expire_at,
                 num_of_seats=licensed_item_purchase_db.num_of_seats,
                 purchased_by_user=licensed_item_purchase_db.purchased_by_user,
+                user_email=licensed_item_purchase_db.user_email,
                 purchased_at=licensed_item_purchase_db.purchased_at,
                 modified=licensed_item_purchase_db.modified,
             )
@@ -96,6 +97,7 @@ async def get_licensed_item_purchase(
         expire_at=licensed_item_purchase_db.expire_at,
         num_of_seats=licensed_item_purchase_db.num_of_seats,
         purchased_by_user=licensed_item_purchase_db.purchased_by_user,
+        user_email=licensed_item_purchase_db.user_email,
         purchased_at=licensed_item_purchase_db.purchased_at,
         modified=licensed_item_purchase_db.modified,
     )
@@ -120,6 +122,7 @@ async def create_licensed_item_purchase(
             expire_at=data.expire_at,
             num_of_seats=data.num_of_seats,
             purchased_by_user=data.purchased_by_user,
+            user_email=data.user_email,
             purchased_at=data.purchased_at,
         )
 
@@ -169,6 +172,7 @@ async def create_licensed_item_purchase(
         expire_at=licensed_item_purchase_db.expire_at,
         num_of_seats=licensed_item_purchase_db.num_of_seats,
         purchased_by_user=licensed_item_purchase_db.purchased_by_user,
+        user_email=licensed_item_purchase_db.user_email,
         purchased_at=licensed_item_purchase_db.purchased_at,
         modified=licensed_item_purchase_db.modified,
     )

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/modules/db/credit_transactions_db.py

@@ -165,7 +165,10 @@ async def batch_update_credit_transaction_status_for_in_debt_transactions(
         )
     async with transaction_context(engine, connection) as conn:
         result = await conn.execute(update_stmt)
-        print(result)
+        if result.rowcount:
+            _logger.info(
+                f"Wallet {wallet_id} and project {project_id} transactions in DEBT were changed to BILLED. Num. of transaction {result.rowcount}"
+            )
 
 
 async def sum_wallet_credits(

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/modules/db/licensed_items_purchases_db.py

@@ -37,6 +37,7 @@
     resource_tracker_licensed_items_purchases.c.expire_at,
     resource_tracker_licensed_items_purchases.c.num_of_seats,
     resource_tracker_licensed_items_purchases.c.purchased_by_user,
+    resource_tracker_licensed_items_purchases.c.user_email,
     resource_tracker_licensed_items_purchases.c.purchased_at,
     resource_tracker_licensed_items_purchases.c.modified,
 )
@@ -66,6 +67,7 @@ async def create(
                 expire_at=data.expire_at,
                 num_of_seats=data.num_of_seats,
                 purchased_by_user=data.purchased_by_user,
+                user_email=data.user_email,
                 purchased_at=data.purchased_at,
                 modified=sa.func.now(),
             )