🐛 fix bug pricing plan listing + introduce unit_specific_info field (…

…🗃️) (#4839)

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

@@ -14,6 +14,7 @@
 class PricingUnitGet(BaseModel):
     pricing_unit_id: PricingUnitId
     unit_name: str
+    unit_extra_info: dict
     current_cost_per_unit: Decimal
     current_cost_per_unit_id: PricingUnitCostId
     default: bool
@@ -25,6 +26,7 @@ class Config:
                 {
                     "pricing_unit_id": 1,
                     "unit_name": "SMALL",
+                    "unit_extra_info": {},
                     "current_cost_per_unit": 5.7,
                     "current_cost_per_unit_id": 1,
                     "default": True,

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

@@ -43,6 +43,7 @@ class ServiceRunGet(
 class PricingUnitGet(OutputSchema):
     pricing_unit_id: PricingUnitId
     unit_name: str
+    unit_extra_info: dict
     current_cost_per_unit: Decimal
     default: bool
 

packages/postgres-database/src/simcore_postgres_database/migration/versions/f613247f5bb1_refactor_pricing_units_table.py

@@ -0,0 +1,46 @@
+"""refactor pricing units table
+
+Revision ID: f613247f5bb1
+Revises: 57ab8c419ca6
+Create Date: 2023-10-07 15:13:38.557368+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "f613247f5bb1"
+down_revision = "57ab8c419ca6"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("resource_tracker_pricing_unit_costs", "specific_info")
+    op.add_column(
+        "resource_tracker_pricing_units",
+        sa.Column(
+            "unit_extra_info",
+            postgresql.JSONB(astext_type=sa.Text()),
+            server_default=sa.text("'{}'::jsonb"),
+            nullable=False,
+        ),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("resource_tracker_pricing_units", "unit_extra_info")
+    op.add_column(
+        "resource_tracker_pricing_unit_costs",
+        sa.Column(
+            "specific_info",
+            postgresql.JSONB(astext_type=sa.Text()),
+            autoincrement=False,
+            nullable=False,
+        ),
+    )
+    # ### end Alembic commands ###

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

@@ -19,7 +19,7 @@
     metadata,
     sa.Column(
         "project_node_id",
-        sa.Integer,
+        sa.BIGINT,
         sa.ForeignKey(
             projects_nodes.c.project_node_id,
             onupdate="CASCADE",

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

@@ -5,7 +5,6 @@
     history and do not update the rows of this table.
 """
 import sqlalchemy as sa
-from sqlalchemy.dialects.postgresql import JSONB
 
 from ._common import NUMERIC_KWARGS, column_created_datetime, column_modified_datetime
 from .base import metadata
@@ -65,13 +64,6 @@
         doc="To when the pricing unit was active, if null it is still active",
         index=True,
     ),
-    sa.Column(
-        "specific_info",
-        JSONB,
-        nullable=False,
-        default="'{}'::jsonb",
-        doc="Specific internal info of the pricing unit, ex. for tiers we can store in which EC2 instance type we run the service.",
-    ),
     column_created_datetime(timezone=True),
     sa.Column(
         "comment",

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

@@ -39,6 +39,13 @@
         nullable=False,
         doc="The custom name of the pricing plan, ex. SMALL, MEDIUM, LARGE",
     ),
+    sa.Column(
+        "unit_extra_info",
+        JSONB,
+        nullable=False,
+        default="'{}'::jsonb",
+        doc="Additional public information about pricing unit, ex. more detail description or how many CPUs there are.",
+    ),
     sa.Column(
         "default",
         sa.Boolean(),

services/resource-usage-tracker/openapi.json

@@ -540,6 +540,7 @@
         "required": [
           "pricing_unit_id",
           "unit_name",
+          "unit_extra_info",
           "current_cost_per_unit",
           "current_cost_per_unit_id",
           "default",
@@ -557,6 +558,10 @@
             "title": "Unit Name",
             "type": "string"
           },
+          "unit_extra_info": {
+            "title": "Unit Extra Info",
+            "type": "object"
+          },
           "current_cost_per_unit": {
             "title": "Current Cost Per Unit",
             "type": "number"

services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/core/application.py

@@ -3,6 +3,10 @@
 from fastapi import FastAPI
 from fastapi_pagination import add_pagination as setup_fastapi_pagination
 from servicelib.fastapi.openapi import override_fastapi_openapi_method
+from simcore_service_resource_usage_tracker.core.errors import (
+    CustomResourceUsageTrackerError,
+    http404_error_handler,
+)
 
 from .._meta import (
     API_VERSION,
@@ -45,7 +49,7 @@ def create_app(settings: ApplicationSettings) -> FastAPI:
     setup_fastapi_pagination(app)
 
     # ERROR HANDLERS
-    # ... add here ...
+    app.add_exception_handler(CustomResourceUsageTrackerError, http404_error_handler)
 
     if settings.RESOURCE_USAGE_TRACKER_POSTGRES:
         setup_db(app)

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

@@ -1,3 +1,5 @@
+from fastapi import Request
+from fastapi.responses import JSONResponse
 from pydantic.errors import PydanticErrorMixin
 
 
@@ -9,13 +11,12 @@ class ConfigurationError(ResourceUsageTrackerRuntimeError):
     msg_template: str = "Application misconfiguration: {msg}"
 
 
-class CreateServiceRunError(ResourceUsageTrackerRuntimeError):
-    msg_template: str = "Error during creation of new service run record in DB: {msg}"
-
-
-class CreateTransactionError(ResourceUsageTrackerRuntimeError):
-    msg_template: str = "Error during creation of new transaction record in DB: {msg}"
+class CustomResourceUsageTrackerError(ResourceUsageTrackerRuntimeError):
+    msg_template: str = "Error: {msg}"
 
 
-class ResourceUsageTrackerCustomRuntimeError(ResourceUsageTrackerRuntimeError):
-    msg_template: str = "Error: {msg}"
+def http404_error_handler(
+    request: Request,  # pylint: disable=unused-argument
+    error: CustomResourceUsageTrackerError,
+) -> JSONResponse:
+    return JSONResponse(status_code=404, content={"message": error.msg_template})

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

@@ -18,7 +18,6 @@ class PricingUnitCostsDB(BaseModel):
     cost_per_unit: Decimal
     valid_from: datetime
     valid_to: datetime | None
-    specific_info: dict
     created: datetime
     comment: str
     modified: datetime

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

@@ -13,6 +13,7 @@ class PricingUnitsDB(BaseModel):
     pricing_unit_id: PricingUnitId
     pricing_plan_id: PricingPlanId
     unit_name: str
+    unit_extra_info: dict
     default: bool
     specific_info: dict
     created: datetime

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

@@ -43,11 +43,7 @@
 )
 from sqlalchemy.dialects.postgresql import ARRAY, INTEGER
 
-from ....core.errors import (
-    CreateServiceRunError,
-    CreateTransactionError,
-    ResourceUsageTrackerCustomRuntimeError,
-)
+from ....core.errors import CustomResourceUsageTrackerError
 from ....models.resource_tracker_credit_transactions import (
     CreditTransactionCreate,
     CreditTransactionCreditsAndStatusUpdate,
@@ -110,7 +106,9 @@ async def create_service_run(self, data: ServiceRunCreate) -> ServiceRunId:
             result = await conn.execute(insert_stmt)
         row = result.first()
         if row is None:
-            raise CreateServiceRunError(msg=f"Service was not created: {data}")
+            raise CustomResourceUsageTrackerError(
+                msg=f"Service was not created: {data}"
+            )
         return row[0]
 
     async def update_service_run_last_heartbeat(
@@ -292,7 +290,9 @@ async def create_credit_transaction(
             result = await conn.execute(insert_stmt)
         row = result.first()
         if row is None:
-            raise CreateTransactionError(msg=f"Transaction was not created: {data}")
+            raise CustomResourceUsageTrackerError(
+                msg=f"Transaction was not created: {data}"
+            )
         return row[0]
 
     async def update_credit_transaction_credits(
@@ -399,12 +399,22 @@ def _version(column_or_value):
             return sa.func.string_to_array(column_or_value, ".").cast(ARRAY(INTEGER))
 
         async with self.db_engine.begin() as conn:
-            query = sa.select(
-                resource_tracker_pricing_plan_to_service.c.service_key,
-                resource_tracker_pricing_plan_to_service.c.service_version,
-            )
+            # Firstly find the correct service version
             query = (
-                query.where(
+                sa.select(
+                    resource_tracker_pricing_plan_to_service.c.service_key,
+                    resource_tracker_pricing_plan_to_service.c.service_version,
+                )
+                .select_from(
+                    resource_tracker_pricing_plan_to_service.join(
+                        resource_tracker_pricing_plans,
+                        (
+                            resource_tracker_pricing_plan_to_service.c.pricing_plan_id
+                            == resource_tracker_pricing_plans.c.pricing_plan_id
+                        ),
+                    )
+                )
+                .where(
                     (
                         _version(
                             resource_tracker_pricing_plan_to_service.c.service_version
@@ -425,36 +435,49 @@ def _version(column_or_value):
                 )
                 .limit(1)
             )
-
             result = await conn.execute(query)
             row = result.first()
             if row is None:
                 return []
             latest_service_key, latest_service_version = row
-
-            query = sa.select(
-                resource_tracker_pricing_plans.c.pricing_plan_id,
-                resource_tracker_pricing_plans.c.display_name,
-                resource_tracker_pricing_plans.c.description,
-                resource_tracker_pricing_plans.c.classification,
-                resource_tracker_pricing_plans.c.is_active,
-                resource_tracker_pricing_plans.c.created,
-                resource_tracker_pricing_plans.c.pricing_plan_key,
-                resource_tracker_pricing_plan_to_service.c.service_default_plan,
-            )
-            query = query.where(
-                (
-                    _version(resource_tracker_pricing_plan_to_service.c.service_version)
-                    == _version(latest_service_version)
+            # Now choose all pricing plans connected to this service
+            query = (
+                sa.select(
+                    resource_tracker_pricing_plans.c.pricing_plan_id,
+                    resource_tracker_pricing_plans.c.display_name,
+                    resource_tracker_pricing_plans.c.description,
+                    resource_tracker_pricing_plans.c.classification,
+                    resource_tracker_pricing_plans.c.is_active,
+                    resource_tracker_pricing_plans.c.created,
+                    resource_tracker_pricing_plans.c.pricing_plan_key,
+                    resource_tracker_pricing_plan_to_service.c.service_default_plan,
                 )
-                & (
-                    resource_tracker_pricing_plan_to_service.c.service_key
-                    == latest_service_key
+                .select_from(
+                    resource_tracker_pricing_plan_to_service.join(
+                        resource_tracker_pricing_plans,
+                        (
+                            resource_tracker_pricing_plan_to_service.c.pricing_plan_id
+                            == resource_tracker_pricing_plans.c.pricing_plan_id
+                        ),
+                    )
+                )
+                .where(
+                    (
+                        _version(
+                            resource_tracker_pricing_plan_to_service.c.service_version
+                        )
+                        == _version(latest_service_version)
+                    )
+                    & (
+                        resource_tracker_pricing_plan_to_service.c.service_key
+                        == latest_service_key
+                    )
+                    & (resource_tracker_pricing_plans.c.product_name == product_name)
+                    & (resource_tracker_pricing_plans.c.is_active.is_(True))
+                )
+                .order_by(
+                    resource_tracker_pricing_plan_to_service.c.pricing_plan_id.desc()
                 )
-                & (resource_tracker_pricing_plans.c.product_name == product_name)
-                & (resource_tracker_pricing_plans.c.is_active.is_(True))
-            ).order_by(
-                resource_tracker_pricing_plan_to_service.c.pricing_plan_id.desc()
             )
             result = await conn.execute(query)
 
@@ -473,6 +496,7 @@ def _pricing_units_select_stmt():
             resource_tracker_pricing_units.c.pricing_unit_id,
             resource_tracker_pricing_units.c.pricing_plan_id,
             resource_tracker_pricing_units.c.unit_name,
+            resource_tracker_pricing_units.c.unit_extra_info,
             resource_tracker_pricing_units.c.default,
             resource_tracker_pricing_units.c.specific_info,
             resource_tracker_pricing_units.c.created,
@@ -567,7 +591,7 @@ async def get_pricing_unit(
 
         row = result.first()
         if row is None:
-            raise ResourceUsageTrackerCustomRuntimeError(
+            raise CustomResourceUsageTrackerError(
                 msg=f"Pricing unit id {pricing_unit_id} not found"
             )
         return PricingUnitsDB.from_orm(row)
@@ -589,7 +613,6 @@ async def get_pricing_unit_cost_by_id(
                 resource_tracker_pricing_unit_costs.c.cost_per_unit,
                 resource_tracker_pricing_unit_costs.c.valid_from,
                 resource_tracker_pricing_unit_costs.c.valid_to,
-                resource_tracker_pricing_unit_costs.c.specific_info,
                 resource_tracker_pricing_unit_costs.c.created,
                 resource_tracker_pricing_unit_costs.c.comment,
                 resource_tracker_pricing_unit_costs.c.modified,
@@ -601,7 +624,7 @@ async def get_pricing_unit_cost_by_id(
 
         row = result.first()
         if row is None:
-            raise ResourceUsageTrackerCustomRuntimeError(
-                msg=f"Pricing unit cosd id {pricing_unit_cost_id} not found in the resource_tracker_pricing_unit_costs table"
+            raise CustomResourceUsageTrackerError(
+                msg=f"Pricing unit cosd id {pricing_unit_cost_id} not found in the resource_tracker_pricing_unit_costs table",
             )
         return PricingUnitCostsDB.from_orm(row)