add get and list license usages

matusdrobuliak66 · matusdrobuliak66 · commit 3f30f05d6a2c · 2024-12-17T11:11:35.000+01:00
diff --git a/packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/resource_usage_tracker/licensed_items_purchases.py b/packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/resource_usage_tracker/licensed_items_purchases.py
@@ -38,8 +38,14 @@ async def get_licensed_items_purchases_page(
     wallet_id: WalletID,
     offset: int = 0,
     limit: int = 20,
-    order_by: OrderBy = OrderBy(field=IDStr("purchased_at")),
+    order_by: OrderBy | None = None,
 ) -> LicensedItemsPurchasesPage:
+    """
+    Default order_by field is "purchased_at"
+    """
+    if order_by is None:
+        order_by = OrderBy(field=IDStr("purchased_at"))
+
     result = await rabbitmq_rpc_client.request(
         RESOURCE_USAGE_TRACKER_RPC_NAMESPACE,
         _RPC_METHOD_NAME_ADAPTER.validate_python("get_licensed_items_purchases_page"),
diff --git a/packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/resource_usage_tracker/licensed_items_usages.py b/packages/service-library/src/servicelib/rabbitmq/rpc_interfaces/resource_usage_tracker/licensed_items_usages.py
@@ -7,12 +7,16 @@
 from models_library.api_schemas_resource_usage_tracker.licensed_items_usages import (
     LicenseCheckoutGet,
     LicenseCheckoutID,
+    LicensedItemsUsagesPage,
     LicensedItemUsageGet,
 )
+from models_library.basic_types import IDStr
 from models_library.licensed_items import LicensedItemID
 from models_library.products import ProductName
 from models_library.rabbitmq_basic_types import RPCMethodName
 from models_library.resource_tracker import ServiceRunId
+from models_library.resource_tracker_licensed_items_usages import LicensedItemUsageID
+from models_library.rest_ordering import OrderBy
 from models_library.users import UserID
 from models_library.wallets import WalletID
 from pydantic import NonNegativeInt, TypeAdapter
@@ -28,46 +32,52 @@
 _RPC_METHOD_NAME_ADAPTER: TypeAdapter[RPCMethodName] = TypeAdapter(RPCMethodName)
 
 
-# @log_decorator(_logger, level=logging.DEBUG)
-# async def get_licensed_items_usages_page(
-#     rabbitmq_rpc_client: RabbitMQRPCClient,
-#     *,
-#     product_name: ProductName,
-#     wallet_id: WalletID,
-#     offset: int = 0,
-#     limit: int = 20,
-#     order_by: OrderBy = OrderBy(field=IDStr("purchased_at")),
-# ) -> LicensedItemsPurchasesPage:
-#     result = await rabbitmq_rpc_client.request(
-#         RESOURCE_USAGE_TRACKER_RPC_NAMESPACE,
-#         _RPC_METHOD_NAME_ADAPTER.validate_python("get_licensed_items_purchases_page"),
-#         product_name=product_name,
-#         wallet_id=wallet_id,
-#         limit=limit,
-#         offset=offset,
-#         order_by=order_by,
-#         timeout_s=_DEFAULT_TIMEOUT_S,
-#     )
-#     assert isinstance(result, LicensedItemsPurchasesPage)  # nosec
-#     return result
+@log_decorator(_logger, level=logging.DEBUG)
+async def get_licensed_item_usage(
+    rabbitmq_rpc_client: RabbitMQRPCClient,
+    *,
+    product_name: ProductName,
+    licensed_item_usage_id: LicensedItemUsageID,
+) -> LicensedItemUsageGet:
+    result = await rabbitmq_rpc_client.request(
+        RESOURCE_USAGE_TRACKER_RPC_NAMESPACE,
+        _RPC_METHOD_NAME_ADAPTER.validate_python("get_licensed_item_usage"),
+        product_name=product_name,
+        licensed_item_usage_id=licensed_item_usage_id,
+        timeout_s=_DEFAULT_TIMEOUT_S,
+    )
+    assert isinstance(result, LicensedItemUsageGet)  # nosec
+    return result
 
 
-# @log_decorator(_logger, level=logging.DEBUG)
-# async def get_licensed_item_usage(
-#     rabbitmq_rpc_client: RabbitMQRPCClient,
-#     *,
-#     product_name: ProductName,
-#     licensed_item_purchase_id: LicensedItemPurchaseID,
-# ) -> LicensedItemPurchaseGet:
-#     result = await rabbitmq_rpc_client.request(
-#         RESOURCE_USAGE_TRACKER_RPC_NAMESPACE,
-#         _RPC_METHOD_NAME_ADAPTER.validate_python("get_licensed_item_purchase"),
-#         product_name=product_name,
-#         licensed_item_purchase_id=licensed_item_purchase_id,
-#         timeout_s=_DEFAULT_TIMEOUT_S,
-#     )
-#     assert isinstance(result, LicensedItemPurchaseGet)  # nosec
-#     return result
+@log_decorator(_logger, level=logging.DEBUG)
+async def get_licensed_items_usages_page(
+    rabbitmq_rpc_client: RabbitMQRPCClient,
+    *,
+    product_name: ProductName,
+    filter_wallet_id: WalletID,
+    offset: int = 0,
+    limit: int = 20,
+    order_by: OrderBy | None = None,
+) -> LicensedItemsUsagesPage:
+    """
+    Default order_by field is "started_at"
+    """
+    if order_by is None:
+        order_by = OrderBy(field=IDStr("started_at"))
+
+    result = await rabbitmq_rpc_client.request(
+        RESOURCE_USAGE_TRACKER_RPC_NAMESPACE,
+        _RPC_METHOD_NAME_ADAPTER.validate_python("get_licensed_items_usages_page"),
+        product_name=product_name,
+        filter_wallet_id=filter_wallet_id,
+        limit=limit,
+        offset=offset,
+        order_by=order_by,
+        timeout_s=_DEFAULT_TIMEOUT_S,
+    )
+    assert isinstance(result, LicensedItemsUsagesPage)  # nosec
+    return result
 
 
 @log_decorator(_logger, level=logging.DEBUG)
diff --git a/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/api/rpc/_licensed_items_usages.py b/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/api/rpc/_licensed_items_usages.py
@@ -2,11 +2,14 @@
 from models_library.api_schemas_resource_usage_tracker.licensed_items_usages import (
     LicenseCheckoutGet,
     LicenseCheckoutID,
+    LicensedItemsUsagesPage,
     LicensedItemUsageGet,
 )
 from models_library.licensed_items import LicensedItemID
 from models_library.products import ProductName
 from models_library.resource_tracker import ServiceRunId
+from models_library.resource_tracker_licensed_items_usages import LicensedItemUsageID
+from models_library.rest_ordering import OrderBy
 from models_library.users import UserID
 from models_library.wallets import WalletID
 from servicelib.rabbitmq import RPCRouter
@@ -16,6 +19,40 @@
 router = RPCRouter()
 
 
+@router.expose(reraise_if_error_type=())
+async def get_licensed_item_usage(
+    app: FastAPI,
+    *,
+    product_name: ProductName,
+    licensed_item_usage_id: LicensedItemUsageID,
+) -> LicensedItemUsageGet:
+    return await licensed_items_usages.get_licensed_item_usage(
+        db_engine=app.state.engine,
+        product_name=product_name,
+        licensed_item_usage_id=licensed_item_usage_id,
+    )
+
+
+@router.expose(reraise_if_error_type=())
+async def get_licensed_items_usages_page(
+    app: FastAPI,
+    *,
+    product_name: ProductName,
+    filter_wallet_id: WalletID,
+    offset: int = 0,
+    limit: int = 20,
+    order_by: OrderBy,
+) -> LicensedItemsUsagesPage:
+    return await licensed_items_usages.list_licensed_items_usages(
+        db_engine=app.state.engine,
+        product_name=product_name,
+        filter_wallet_id=filter_wallet_id,
+        offset=offset,
+        limit=limit,
+        order_by=order_by,
+    )
+
+
 @router.expose(reraise_if_error_type=())
 async def checkout_licensed_item(
     app: FastAPI,
diff --git a/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/licensed_items_usages.py b/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/licensed_items_usages.py
@@ -29,13 +29,13 @@
 )
 
 
-async def list_licensed_items_purchases(
+async def list_licensed_items_usages(
     db_engine: Annotated[AsyncEngine, Depends(get_resource_tracker_db_engine)],
     *,
     product_name: ProductName,
     filter_wallet_id: WalletID,
-    offset: int = 0,
-    limit: int = 20,
+    offset: int,
+    limit: int,
     order_by: OrderBy,
 ) -> LicensedItemsUsagesPage:
     total, licensed_items_usages_list_db = await licensed_items_usages_db.list_(
diff --git a/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/modules/db/licensed_items_usages_db.py b/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/services/modules/db/licensed_items_usages_db.py
@@ -128,7 +128,7 @@ async def get(
         .select_from(resource_tracker_licensed_items_usage)
         .where(
             (
-                resource_tracker_licensed_items_usage.c.licensed_item_purchase_id
+                resource_tracker_licensed_items_usage.c.licensed_item_usage_id
                 == licensed_item_usage_id
             )
             & (resource_tracker_licensed_items_usage.c.product_name == product_name)
diff --git a/services/resource-usage-tracker/tests/unit/with_dbs/test_api_licensed_items_usages.py b/services/resource-usage-tracker/tests/unit/with_dbs/test_api_licensed_items_usages.py
@@ -10,6 +10,10 @@
 
 import pytest
 import sqlalchemy as sa
+from models_library.api_schemas_resource_usage_tracker.licensed_items_usages import (
+    LicensedItemsUsagesPage,
+    LicensedItemUsageGet,
+)
 from models_library.resource_tracker_licensed_items_purchases import (
     LicensedItemsPurchasesCreate,
 )
@@ -18,6 +22,9 @@
     licensed_items_purchases,
     licensed_items_usages,
 )
+from simcore_postgres_database.models.resource_tracker_licensed_items_usage import (
+    resource_tracker_licensed_items_usage,
+)
 from simcore_postgres_database.models.resource_tracker_service_runs import (
     resource_tracker_service_runs,
 )
@@ -31,18 +38,6 @@
 ]
 
 
-async def test_service_licensed_items_usages(
-    mocked_redis_server: None,
-    postgres_db: sa.engine.Engine,
-    rpc_client: RabbitMQRPCClient,
-):
-    ...
-
-    # List licensed items usages
-
-    # Get licensed items usages
-
-
 _USER_ID_1 = 1
 _WALLET_ID = 6
 
@@ -66,15 +61,24 @@ def resource_tracker_service_run_id(
 
         yield row[0]
 
+        con.execute(resource_tracker_licensed_items_usage.delete())
         con.execute(resource_tracker_service_runs.delete())
 
 
 async def test_rpc_licensed_items_usages_workflow(
     mocked_redis_server: None,
-    postgres_db: sa.engine.Engine,
     resource_tracker_service_run_id: str,
     rpc_client: RabbitMQRPCClient,
 ):
+    # List licensed items usages
+    output = await licensed_items_usages.get_licensed_items_usages_page(
+        rpc_client,
+        product_name="osparc",
+        filter_wallet_id=_WALLET_ID,
+    )
+    assert output.total == 0
+    assert output.items == []
+
     # Purchase license item
     _create_data = LicensedItemsPurchasesCreate(
         product_name="osparc",
@@ -108,6 +112,23 @@ async def test_rpc_licensed_items_usages_workflow(
         user_email="test@test.com",
     )
 
+    # List licensed items usages
+    output = await licensed_items_usages.get_licensed_items_usages_page(
+        rpc_client,
+        product_name="osparc",
+        filter_wallet_id=_WALLET_ID,
+    )
+    assert output.total == 1
+    assert isinstance(output, LicensedItemsUsagesPage)
+
+    # Get licensed items usages
+    output = await licensed_items_usages.get_licensed_item_usage(
+        rpc_client,
+        product_name="osparc",
+        licensed_item_usage_id=output.items[0].licensed_item_usage_id,
+    )
+    assert isinstance(output, LicensedItemUsageGet)
+
     # Release num of seats
     license_item_usage = await licensed_items_usages.release_licensed_item(
         rpc_client, checkout_id=checkout.checkout_id, product_name="osparc"
diff --git a/services/web/server/src/simcore_service_webserver/licenses/_licensed_items_usages_api.py b/services/web/server/src/simcore_service_webserver/licenses/_licensed_items_usages_api.py
@@ -62,33 +62,34 @@ async def release_licensed_item_for_wallet(
     checkout_id: rut_licensed_items_usages.LicenseCheckoutID,
 ) -> webserver_licensed_items_usages.LicensedItemUsageGet:
     rpc_client = get_rabbitmq_rpc_client(app)
-    licensed_item_get: rut_licensed_items_usages.LicensedItemUsageGet = (
-        await licensed_items_usages.release_licensed_item(
-            rpc_client,
-            product_name=product_name,
-            checkout_id=checkout_id,
-        )
+    # Get
+    checkout_item = await licensed_items_usages.get_licensed_item_usage(
+        rpc_client, product_name=product_name, licensed_item_usage_id=checkout_id
     )
 
     # Check whether user has access to the wallet
     await get_wallet_by_user(
         app,
         user_id=user_id,
-        wallet_id=licensed_item_get.wallet_id,
+        wallet_id=checkout_item.wallet_id,
         product_name=product_name,
     )
 
+    licensed_item_get: rut_licensed_items_usages.LicensedItemUsageGet = (
+        await licensed_items_usages.release_licensed_item(
+            rpc_client,
+            product_name=product_name,
+            checkout_id=checkout_id,
+        )
+    )
+
     return webserver_licensed_items_usages.LicensedItemUsageGet(
-        licensed_item_purchase_id=licensed_item_get.licensed_item_purchase_id,
-        product_name=licensed_item_get.product_name,
+        licensed_item_usage_id=licensed_item_get.licensed_item_usage_id,
         licensed_item_id=licensed_item_get.licensed_item_id,
         wallet_id=licensed_item_get.wallet_id,
-        pricing_unit_cost_id=licensed_item_get.pricing_unit_cost_id,
-        pricing_unit_cost=licensed_item_get.pricing_unit_cost,
-        start_at=licensed_item_get.start_at,
-        expire_at=licensed_item_get.expire_at,
+        user_id=licensed_item_get.user_id,
+        product_name=licensed_item_get.product_name,
+        started_at=licensed_item_get.started_at,
+        stopped_at=licensed_item_get.stopped_at,
         num_of_seats=licensed_item_get.num_of_seats,
-        purchased_by_user=licensed_item_get.purchased_by_user,
-        purchased_at=licensed_item_get.purchased_at,
-        modified_at=licensed_item_get.modified,
     )

Original file line number	Diff line number	Diff line change
`@@ -128,7 +128,7 @@ async def get(`
`128`	`128`	`.select_from(resource_tracker_licensed_items_usage)`
`129`	`129`	`.where(`
`130`	`130`	`(`
`131`		`- resource_tracker_licensed_items_usage.c.licensed_item_purchase_id`
	`131`	`+ resource_tracker_licensed_items_usage.c.licensed_item_usage_id`
`132`	`132`	`== licensed_item_usage_id`
`133`	`133`	`)`
`134`	`134`	`& (resource_tracker_licensed_items_usage.c.product_name == product_name)`