RUT refactoring (adding key & version)

Author: matusdrobuliak66

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

@@ -15,6 +15,8 @@
 class LicensedItemCheckoutGet(BaseModel):
     licensed_item_checkout_id: LicensedItemCheckoutID
     licensed_item_id: LicensedItemID
+    key: str
+    version: str
     wallet_id: WalletID
     user_id: UserID
     user_email: str
@@ -30,6 +32,8 @@ class LicensedItemCheckoutGet(BaseModel):
                 {
                     "licensed_item_checkout_id": "beb16d18-d57d-44aa-a638-9727fa4a72ef",
                     "licensed_item_id": "303942ef-6d31-4ba8-afbe-dbb1fce2a953",
+                    "key": "Duke",
+                    "version": "1.0.0",
                     "wallet_id": 1,
                     "user_id": 1,
                     "user_email": "[email protected]",

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

@@ -17,6 +17,8 @@ class LicensedItemPurchaseGet(BaseModel):
     licensed_item_purchase_id: LicensedItemPurchaseID
     product_name: ProductName
     licensed_item_id: LicensedItemID
+    key: str
+    version: str
     wallet_id: WalletID
     wallet_name: str
     pricing_unit_cost_id: PricingUnitCostId

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

@@ -17,6 +17,8 @@
 class LicensedItemCheckoutRpcGet(BaseModel):
     licensed_item_checkout_id: LicensedItemCheckoutID
     licensed_item_id: LicensedItemID
+    key: str
+    version: str
     wallet_id: WalletID
     user_id: UserID
     product_name: ProductName
@@ -29,6 +31,8 @@ class LicensedItemCheckoutRpcGet(BaseModel):
                 {
                     "licensed_item_checkout_id": "633ef980-6f3e-4b1a-989a-bd77bf9a5d6b",
                     "licensed_item_id": "0362b88b-91f8-4b41-867c-35544ad1f7a1",
+                    "key": "Duke",
+                    "version": "1.0.0",
                     "wallet_id": 6,
                     "user_id": 27845,
                     "product_name": "osparc",

packages/models-library/src/models_library/licenses.py

@@ -69,26 +69,23 @@ class LicensedItemDB(BaseModel):
     licensed_item_id: LicensedItemID
     display_name: str
 
-    licensed_resource_name: str
+    key: str
+    version: str
     licensed_resource_type: LicensedResourceType
-    licensed_resource_data: dict[str, Any] | None
 
-    pricing_plan_id: PricingPlanId | None
-    product_name: ProductName | None
+    pricing_plan_id: PricingPlanId
+    product_name: ProductName
 
     # states
     created: datetime
     modified: datetime
-    trashed: datetime | None
 
     model_config = ConfigDict(from_attributes=True)
 
 
-class LicensedItemUpdateDB(BaseModel):
+class LicensedItemPatchDB(BaseModel):
     display_name: str | None = None
-    licensed_resource_name: str | None = None
     pricing_plan_id: PricingPlanId | None = None
-    trash: bool | None = None
 
 
 class LicensedResourceDB(BaseModel):

packages/models-library/src/models_library/resource_tracker_licensed_items_purchases.py

@@ -17,6 +17,8 @@
 class LicensedItemsPurchasesCreate(BaseModel):
     product_name: ProductName
     licensed_item_id: LicensedItemID
+    key: str
+    version: str
     wallet_id: WalletID
     wallet_name: str
     pricing_plan_id: PricingPlanId

packages/postgres-database/src/simcore_postgres_database/migration/versions/68777fdf9539_add_licensed_resources.py

@@ -17,7 +17,10 @@
 
 
 # Reuse the existing Enum type
-existing_enum = sa.Enum("VIP_MODEL", name="licensedresourcetype", native_enum=False)
+# existing_enum = sa.Enum("VIP_MODEL", name="licensedresourcetype", native_enum=False)
+licensed_resource_type = postgresql.ENUM(
+    "VIP_MODEL", name="licensedresourcetype", create_type=False
+)
 
 
 def upgrade():
@@ -34,7 +37,7 @@ def upgrade():
         sa.Column("licensed_resource_name", sa.String(), nullable=False),
         sa.Column(
             "licensed_resource_type",
-            existing_enum,  # Reuse existing Enum instead of redefining it
+            licensed_resource_type,  # Reuse existing Enum instead of redefining it
             nullable=False,
         ),
         sa.Column(

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

@@ -0,0 +1,138 @@
+"""modify licensed items/resources DB
+
+Revision ID: ce4224e8b06e
+Revises: 68777fdf9539
+Create Date: 2025-02-11 12:24:47.669339+00:00
+
+"""
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "ce4224e8b06e"
+down_revision = "68777fdf9539"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table(
+        "licensed_item_to_resource",
+        sa.Column("licensed_item_id", postgresql.UUID(as_uuid=True), nullable=False),
+        sa.Column(
+            "licensed_resource_id", postgresql.UUID(as_uuid=True), nullable=False
+        ),
+        sa.Column(
+            "created",
+            sa.DateTime(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=False,
+        ),
+        sa.Column(
+            "modified",
+            sa.DateTime(timezone=True),
+            server_default=sa.text("now()"),
+            nullable=False,
+        ),
+        sa.ForeignKeyConstraint(
+            ["licensed_item_id"],
+            ["licensed_items.licensed_item_id"],
+            name="fk_licensed_item_to_resource_licensed_item_id",
+            onupdate="CASCADE",
+            ondelete="CASCADE",
+        ),
+        sa.ForeignKeyConstraint(
+            ["licensed_resource_id"],
+            ["licensed_resources.licensed_resource_id"],
+            name="fk_licensed_item_to_resource_licensed_resource_id",
+            onupdate="CASCADE",
+            ondelete="CASCADE",
+        ),
+    )
+    op.add_column("licensed_items", sa.Column("key", sa.String(), nullable=False))
+    op.add_column("licensed_items", sa.Column("version", sa.String(), nullable=False))
+    op.alter_column(
+        "licensed_items", "pricing_plan_id", existing_type=sa.BIGINT(), nullable=False
+    )
+    op.alter_column(
+        "licensed_items", "product_name", existing_type=sa.VARCHAR(), nullable=False
+    )
+    op.drop_constraint(
+        "uq_licensed_resource_name_type", "licensed_items", type_="unique"
+    )
+    op.create_unique_constraint(
+        "uq_licensed_items_key_version", "licensed_items", ["key", "version"]
+    )
+    op.drop_column("licensed_items", "trashed")
+    op.drop_column("licensed_items", "licensed_resource_data")
+    op.drop_column("licensed_items", "licensed_resource_name")
+    op.add_column(
+        "resource_tracker_licensed_items_checkouts",
+        sa.Column("key", sa.String(), nullable=False),
+    )
+    op.add_column(
+        "resource_tracker_licensed_items_checkouts",
+        sa.Column("version", sa.String(), nullable=False),
+    )
+    op.add_column(
+        "resource_tracker_licensed_items_purchases",
+        sa.Column("key", sa.String(), nullable=False),
+    )
+    op.add_column(
+        "resource_tracker_licensed_items_purchases",
+        sa.Column("version", sa.String(), nullable=False),
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column("resource_tracker_licensed_items_purchases", "version")
+    op.drop_column("resource_tracker_licensed_items_purchases", "key")
+    op.drop_column("resource_tracker_licensed_items_checkouts", "version")
+    op.drop_column("resource_tracker_licensed_items_checkouts", "key")
+    op.add_column(
+        "licensed_items",
+        sa.Column(
+            "licensed_resource_name", sa.VARCHAR(), autoincrement=False, nullable=False
+        ),
+    )
+    op.add_column(
+        "licensed_items",
+        sa.Column(
+            "licensed_resource_data",
+            postgresql.JSONB(astext_type=sa.Text()),
+            autoincrement=False,
+            nullable=True,
+        ),
+    )
+    op.add_column(
+        "licensed_items",
+        sa.Column(
+            "trashed",
+            postgresql.TIMESTAMP(timezone=True),
+            autoincrement=False,
+            nullable=True,
+            comment="The date and time when the licensed_item was marked as trashed. Null if the licensed_item has not been trashed [default].",
+        ),
+    )
+    op.drop_constraint(
+        "uq_licensed_items_key_version", "licensed_items", type_="unique"
+    )
+    op.create_unique_constraint(
+        "uq_licensed_resource_name_type",
+        "licensed_items",
+        ["licensed_resource_name", "licensed_resource_type"],
+    )
+    op.alter_column(
+        "licensed_items", "product_name", existing_type=sa.VARCHAR(), nullable=True
+    )
+    op.alter_column(
+        "licensed_items", "pricing_plan_id", existing_type=sa.BIGINT(), nullable=True
+    )
+    op.drop_column("licensed_items", "version")
+    op.drop_column("licensed_items", "key")
+    op.drop_table("licensed_item_to_resource")
+    # ### end Alembic commands ###

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

@@ -0,0 +1,34 @@
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+from ._common import RefActions, column_created_datetime, column_modified_datetime
+from .base import metadata
+
+licensed_item_to_resource = sa.Table(
+    "licensed_item_to_resource",
+    metadata,
+    sa.Column(
+        "licensed_item_id",
+        postgresql.UUID(as_uuid=True),
+        sa.ForeignKey(
+            "licensed_items.licensed_item_id",
+            name="fk_licensed_item_to_resource_licensed_item_id",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
+        ),
+        nullable=False,
+    ),
+    sa.Column(
+        "licensed_resource_id",
+        postgresql.UUID(as_uuid=True),
+        sa.ForeignKey(
+            "licensed_resources.licensed_resource_id",
+            name="fk_licensed_item_to_resource_licensed_resource_id",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
+        ),
+        nullable=False,
+    ),
+    column_created_datetime(timezone=True),
+    column_modified_datetime(timezone=True),
+)

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

@@ -6,12 +6,7 @@
 import sqlalchemy as sa
 from sqlalchemy.dialects import postgresql
 
-from ._common import (
-    RefActions,
-    column_created_datetime,
-    column_modified_datetime,
-    column_trashed_datetime,
-)
+from ._common import RefActions, column_created_datetime, column_modified_datetime
 from .base import metadata
 
 
@@ -30,29 +25,27 @@ class LicensedResourceType(str, enum.Enum):
         server_default=sa.text("gen_random_uuid()"),
     ),
     sa.Column(
-        "display_name",
+        "key",
+        sa.String,
+        nullable=False,
+    ),
+    sa.Column(
+        "version",
         sa.String,
         nullable=False,
-        doc="Display name for front-end",
     ),
     sa.Column(
-        "licensed_resource_name",
+        "display_name",
         sa.String,
         nullable=False,
-        doc="Resource name identifier",
+        doc="Display name for front-end",
     ),
     sa.Column(
         "licensed_resource_type",
         sa.Enum(LicensedResourceType),
         nullable=False,
         doc="Resource type, ex. VIP_MODEL",
     ),
-    sa.Column(
-        "licensed_resource_data",
-        postgresql.JSONB,
-        nullable=True,
-        doc="Resource metadata. Used for read-only purposes",
-    ),
     sa.Column(
         "pricing_plan_id",
         sa.BigInteger,
@@ -62,7 +55,7 @@ class LicensedResourceType(str, enum.Enum):
             onupdate=RefActions.CASCADE,
             ondelete=RefActions.RESTRICT,
         ),
-        nullable=True,
+        nullable=False,
     ),
     sa.Column(
         "product_name",
@@ -73,15 +66,14 @@ class LicensedResourceType(str, enum.Enum):
             ondelete=RefActions.CASCADE,
             name="fk_resource_tracker_license_packages_product_name",
         ),
-        nullable=True,
+        nullable=False,
         doc="Product name identifier. If None, then the item is not exposed",
     ),
     column_created_datetime(timezone=True),
     column_modified_datetime(timezone=True),
-    column_trashed_datetime("licensed_item"),
     sa.UniqueConstraint(
-        "licensed_resource_name",
-        "licensed_resource_type",
-        name="uq_licensed_resource_name_type",
+        "key",
+        "version",
+        name="uq_licensed_items_key_version",
     ),
 )

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

@@ -22,6 +22,16 @@
         UUID(as_uuid=True),
         nullable=True,
     ),
+    sa.Column(
+        "key",
+        sa.String,
+        nullable=False,
+    ),
+    sa.Column(
+        "version",
+        sa.String,
+        nullable=False,
+    ),
     sa.Column(
         "wallet_id",
         sa.BigInteger,