imporve error handling

Author: matusdrobuliak66

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

@@ -0,0 +1,29 @@
+from common_library.errors_classes import OsparcErrorMixin
+
+
+class LicensesBaseError(OsparcErrorMixin, Exception):
+    ...
+
+
+class NotEnoughAvailableSeatsError(LicensesBaseError):
+    msg_template = "Not enough available seats. Current available seats {available_num_of_seats} for license item {license_item_id}"
+
+
+class CanNotCheckoutNotEnoughAvailableSeatsError(LicensesBaseError):
+    msg_template = "Can not checkout license item {licensed_item_id} with num of seats {num_of_seats}. Currently available seats {available_num_of_seats}"
+
+
+class CanNotCheckoutServiceIsNotRunningError(LicensesBaseError):
+    msg_template = "Can not checkout license item {licensed_item_id} as dynamic service is not running. Current service {service_run}"
+
+
+class LicensedItemCheckoutNotFoundError(LicensesBaseError):
+    msg_template = "Licensed item checkout {licensed_item_checkout_id} not found."
+
+
+LICENSES_ERRORS = (
+    NotEnoughAvailableSeatsError,
+    CanNotCheckoutNotEnoughAvailableSeatsError,
+    CanNotCheckoutServiceIsNotRunningError,
+    LicensedItemCheckoutNotFoundError,
+)

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

@@ -13,13 +13,16 @@
 from models_library.users import UserID
 from models_library.wallets import WalletID
 from servicelib.rabbitmq import RPCRouter
+from servicelib.rabbitmq.rpc_interfaces.resource_usage_tracker.errors import (
+    LICENSES_ERRORS,
+)
 
 from ...services import licensed_items_checkouts
 
 router = RPCRouter()
 
 
-@router.expose(reraise_if_error_type=())
+@router.expose(reraise_if_error_type=LICENSES_ERRORS)
 async def get_licensed_item_checkout(
     app: FastAPI,
     *,
@@ -33,7 +36,7 @@ async def get_licensed_item_checkout(
     )
 
 
-@router.expose(reraise_if_error_type=())
+@router.expose(reraise_if_error_type=LICENSES_ERRORS)
 async def get_licensed_items_checkouts_page(
     app: FastAPI,
     *,
@@ -53,7 +56,7 @@ async def get_licensed_items_checkouts_page(
     )
 
 
-@router.expose(reraise_if_error_type=())
+@router.expose(reraise_if_error_type=LICENSES_ERRORS)
 async def checkout_licensed_item(
     app: FastAPI,
     *,
@@ -77,7 +80,7 @@ async def checkout_licensed_item(
     )
 
 
-@router.expose(reraise_if_error_type=())
+@router.expose(reraise_if_error_type=LICENSES_ERRORS)
 async def release_licensed_item(
     app: FastAPI,
     *,

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/exceptions/errors.py

@@ -1,7 +1,4 @@
 from common_library.errors_classes import OsparcErrorMixin
-from models_library.resource_tracker_licensed_items_checkouts import (
-    LicensedItemCheckoutID,
-)
 from models_library.resource_tracker_licensed_items_purchases import (
     LicensedItemPurchaseID,
 )
@@ -78,7 +75,3 @@ class PricingPlanNotFoundForServiceError(RutNotFoundError):
 
 class LicensedItemPurchaseNotFoundError(RutNotFoundError):
     licensed_item_purchase_id: LicensedItemPurchaseID
-
-
-class LicensedItemCheckoutNotFoundError(RutNotFoundError):
-    licensed_item_checkout_id: LicensedItemCheckoutID

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

@@ -15,6 +15,11 @@
 from models_library.rest_ordering import OrderBy
 from models_library.users import UserID
 from models_library.wallets import WalletID
+from servicelib.rabbitmq.rpc_interfaces.resource_usage_tracker.errors import (
+    CanNotCheckoutNotEnoughAvailableSeatsError,
+    CanNotCheckoutServiceIsNotRunningError,
+    NotEnoughAvailableSeatsError,
+)
 from sqlalchemy.ext.asyncio import AsyncEngine
 
 from ..api.rest.dependencies import get_resource_tracker_db_engine
@@ -122,10 +127,16 @@ async def checkout_licensed_item(
 
     available_seats = _active_purchased_seats - _currently_used_seats
     if available_seats <= 0:
-        raise ValueError("Not enough available seats")
+        raise NotEnoughAvailableSeatsError(
+            license_item_id=licensed_item_id, available_num_of_seats=available_seats
+        )
 
     if available_seats - num_of_seats < 0:
-        raise ValueError("Can not checkout num of seats, not enough available")
+        raise CanNotCheckoutNotEnoughAvailableSeatsError(
+            license_item_id=licensed_item_id,
+            available_num_of_seats=available_seats,
+            num_of_seats=num_of_seats,
+        )
 
     # Check if the service run ID is currently running
     service_run = await service_runs_db.get_service_run_by_id(
@@ -135,7 +146,9 @@ async def checkout_licensed_item(
         service_run is None
         or service_run.service_run_status != ServiceRunStatus.RUNNING
     ):
-        raise ValueError("This should not happen")
+        raise CanNotCheckoutServiceIsNotRunningError(
+            license_item_id=licensed_item_id, service_run=service_run
+        )
 
     _create_item_checkout = CreateLicensedItemCheckoutDB(
         licensed_item_id=licensed_item_id,

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

@@ -7,6 +7,9 @@
 from models_library.rest_ordering import OrderBy, OrderDirection
 from models_library.wallets import WalletID
 from pydantic import NonNegativeInt
+from servicelib.rabbitmq.rpc_interfaces.resource_usage_tracker.errors import (
+    LicensedItemCheckoutNotFoundError,
+)
 from simcore_postgres_database.models.resource_tracker_licensed_items_checkouts import (
     resource_tracker_licensed_items_checkouts,
 )
@@ -19,7 +22,6 @@
 )
 from sqlalchemy.ext.asyncio import AsyncConnection, AsyncEngine
 
-from ....exceptions.errors import LicensedItemCheckoutNotFoundError
 from ....models.licensed_items_checkouts import (
     CreateLicensedItemCheckoutDB,
     LicensedItemCheckoutDB,

services/web/server/src/simcore_service_webserver/licenses/_rpc.py

@@ -15,14 +15,17 @@
 from models_library.users import UserID
 from models_library.wallets import WalletID
 from servicelib.rabbitmq import RPCRouter
+from servicelib.rabbitmq.rpc_interfaces.resource_usage_tracker.errors import (
+    LICENSES_ERRORS,
+)
 
 from ..rabbitmq import get_rabbitmq_rpc_server
 from . import _licensed_checkouts_api, _licensed_items_api
 
 router = RPCRouter()
 
 
-@router.expose()
+@router.expose(reraise_if_error_type=LICENSES_ERRORS)
 async def get_licensed_items(
     app: web.Application,
     *,
@@ -55,7 +58,7 @@ async def get_purchased_licensed_items_for_wallet(
     raise NotImplementedError
 
 
-@router.expose(reraise_if_error_type=(NotImplementedError,))
+@router.expose(reraise_if_error_type=LICENSES_ERRORS)
 async def checkout_licensed_item_for_wallet(
     app: web.Application,
     *,
@@ -77,7 +80,7 @@ async def checkout_licensed_item_for_wallet(
     )
 
 
-@router.expose(reraise_if_error_type=(NotImplementedError,))
+@router.expose(reraise_if_error_type=LICENSES_ERRORS)
 async def release_licensed_item_for_wallet(
     app: web.Application,
     *,