🐛 add product_name to licensed item/resource mapping table (🗃️) (#7272)

matusdrobuliak66 · web-flow · commit 7dd1e0a5d028 · 2025-02-25T15:18:55.000Z
diff --git a/packages/postgres-database/src/simcore_postgres_database/migration/versions/381336fa8001_add_product_name_to_licensed_item_to_.py b/packages/postgres-database/src/simcore_postgres_database/migration/versions/381336fa8001_add_product_name_to_licensed_item_to_.py
@@ -0,0 +1,75 @@
+"""add product name to licensed item to resource table
+
+Revision ID: 381336fa8001
+Revises: d84edab53761
+Create Date: 2025-02-25 13:37:19.861701+00:00
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "381336fa8001"
+down_revision = "d84edab53761"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.add_column(
+        "licensed_item_to_resource",
+        sa.Column("product_name", sa.String(), nullable=True),
+    )
+
+    ### Added Manually -->
+    op.execute(
+        """
+        UPDATE licensed_item_to_resource
+        SET product_name = 's4l'
+        WHERE product_name IS NULL
+        """
+    )
+    op.alter_column("licensed_item_to_resource", "product_name", nullable=False)
+    ### <-- Added Manually
+
+    op.drop_constraint(
+        "uq_licensed_item_to_resource_resource_id",
+        "licensed_item_to_resource",
+        type_="unique",
+    )
+    op.create_unique_constraint(
+        "uq_licensed_item_to_resource_resource_id",
+        "licensed_item_to_resource",
+        ["product_name", "licensed_resource_id"],
+    )
+    op.create_foreign_key(
+        "fk_licensed_item_to_resource_product_name",
+        "licensed_item_to_resource",
+        "products",
+        ["product_name"],
+        ["name"],
+        onupdate="CASCADE",
+        ondelete="CASCADE",
+    )
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_constraint(
+        "fk_licensed_item_to_resource_product_name",
+        "licensed_item_to_resource",
+        type_="foreignkey",
+    )
+    op.drop_constraint(
+        "uq_licensed_item_to_resource_resource_id",
+        "licensed_item_to_resource",
+        type_="unique",
+    )
+    op.create_unique_constraint(
+        "uq_licensed_item_to_resource_resource_id",
+        "licensed_item_to_resource",
+        ["licensed_resource_id"],
+    )
+    op.drop_column("licensed_item_to_resource", "product_name")
+    # ### end Alembic commands ###
diff --git a/packages/postgres-database/src/simcore_postgres_database/models/licensed_item_to_resource.py b/packages/postgres-database/src/simcore_postgres_database/models/licensed_item_to_resource.py
@@ -29,14 +29,31 @@
         ),
         nullable=False,
     ),
+    sa.Column(
+        "product_name",
+        sa.String,
+        sa.ForeignKey(
+            "products.name",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
+            name="fk_licensed_item_to_resource_product_name",
+        ),
+        nullable=False,
+    ),
     column_created_datetime(timezone=True),
     column_modified_datetime(timezone=True),
     #########
+    sa.PrimaryKeyConstraint(
+        "licensed_item_id",
+        "licensed_resource_id",
+        name="pk_licensed_item_to_resource_item_and_resource_id",
+    ),
     # NOTE: Currently, there is a constraint that a resource item ID cannot be in multiple licensed items.
     # The reason is that the license key and license version coming from the internal license server are part of the licensed resource domain.
     # Sim4Life performs a mapping on their side, where the license key and version are mapped to a licensed item.
     # If this constraint is broken, the mapping logic in Sim4Life might break.
     sa.UniqueConstraint(
+        "product_name",
         "licensed_resource_id",
         name="uq_licensed_item_to_resource_resource_id",
     ),
diff --git a/services/web/server/src/simcore_service_webserver/licenses/_licensed_items_repository.py b/services/web/server/src/simcore_service_webserver/licenses/_licensed_items_repository.py
@@ -212,33 +212,39 @@ async def delete(
 ### LICENSED ITEMS DOMAIN
 
 
-# Step 1: Create an ordered subquery
-_ordered_subquery = (
-    select(
-        licensed_item_to_resource.c.licensed_item_id,
-        licensed_resources.c.licensed_resource_data,
-        licensed_resources.c.priority,
-        licensed_resources.c.licensed_resource_id,
-    )
-    .select_from(
-        licensed_item_to_resource.join(
-            licensed_resources,
-            licensed_resources.c.licensed_resource_id
-            == licensed_item_to_resource.c.licensed_resource_id,
+def _create_licensed_resource_subquery(product_name: ProductName):
+    # Step 1: Create an ordered subquery
+    _ordered_subquery = (
+        select(
+            licensed_item_to_resource.c.licensed_item_id,
+            licensed_resources.c.licensed_resource_data,
+            licensed_resources.c.priority,
+            licensed_resources.c.licensed_resource_id,
         )
-    )
-    .order_by(licensed_resources.c.priority, licensed_resources.c.licensed_resource_id)
-).subquery("ordered_subquery")
+        .select_from(
+            licensed_item_to_resource.join(
+                licensed_resources,
+                licensed_resources.c.licensed_resource_id
+                == licensed_item_to_resource.c.licensed_resource_id,
+            )
+        )
+        .where(licensed_item_to_resource.c.product_name == product_name)
+        .order_by(
+            licensed_resources.c.priority, licensed_resources.c.licensed_resource_id
+        )
+    ).subquery("ordered_subquery")
 
-# Step 2: Aggregate the ordered subquery results
-_licensed_resource_subquery = (
-    select(
-        _ordered_subquery.c.licensed_item_id,
-        func.array_agg(_ordered_subquery.c.licensed_resource_data).label(
-            "licensed_resources"
-        ),
-    ).group_by(_ordered_subquery.c.licensed_item_id)
-).subquery("licensed_resource_subquery")
+    # Step 2: Aggregate the ordered subquery results
+    _licensed_resource_subquery = (
+        select(
+            _ordered_subquery.c.licensed_item_id,
+            func.array_agg(_ordered_subquery.c.licensed_resource_data).label(
+                "licensed_resources"
+            ),
+        ).group_by(_ordered_subquery.c.licensed_item_id)
+    ).subquery("licensed_resource_subquery")
+
+    return _licensed_resource_subquery  # noqa: RET504
 
 
 async def get_licensed_item_by_key_version(
@@ -250,6 +256,10 @@ async def get_licensed_item_by_key_version(
     product_name: ProductName,
 ) -> LicensedItem:
 
+    _licensed_resource_subquery = _create_licensed_resource_subquery(
+        product_name=product_name
+    )
+
     select_query = (
         select(
             licensed_items.c.licensed_item_id,
@@ -298,6 +308,10 @@ async def list_licensed_items(
     include_hidden_items_on_market: bool = False,
 ) -> tuple[int, list[LicensedItem]]:
 
+    _licensed_resource_subquery = _create_licensed_resource_subquery(
+        product_name=product_name
+    )
+
     base_query = (
         select(
             licensed_items.c.licensed_item_id,
diff --git a/services/web/server/tests/unit/with_dbs/04/licenses/test_licensed_items_repository.py b/services/web/server/tests/unit/with_dbs/04/licenses/test_licensed_items_repository.py
@@ -205,14 +205,17 @@ async def test_licensed_items_domain_listing(
                 {
                     "licensed_item_id": got_duke1.licensed_item_id,
                     "licensed_resource_id": got_licensed_resource_duke1.licensed_resource_id,
+                    "product_name": osparc_product_name,
                 },
                 {
                     "licensed_item_id": got_duke1.licensed_item_id,
                     "licensed_resource_id": got_licensed_resource_duke1_different_id.licensed_resource_id,
+                    "product_name": osparc_product_name,
                 },
                 {
                     "licensed_item_id": got_duke2.licensed_item_id,
                     "licensed_resource_id": got_licensed_resource_duke2.licensed_resource_id,
+                    "product_name": osparc_product_name,
                 },
             ],
         )
diff --git a/services/web/server/tests/unit/with_dbs/04/licenses/test_licensed_items_rest.py b/services/web/server/tests/unit/with_dbs/04/licenses/test_licensed_items_rest.py
@@ -86,6 +86,7 @@ async def test_licensed_items_listing(
             licensed_item_to_resource.insert().values(
                 licensed_item_id=_licensed_item_id,
                 licensed_resource_id=got_licensed_resource_duke.licensed_resource_id,
+                product_name=osparc_product_name,
             )
         )
 
@@ -215,6 +216,7 @@ async def test_licensed_items_purchase(
             licensed_item_to_resource.insert().values(
                 licensed_item_id=_licensed_item_id,
                 licensed_resource_id=got_licensed_resource_duke.licensed_resource_id,
+                product_name=osparc_product_name,
             )
         )
 
diff --git a/services/web/server/tests/unit/with_dbs/04/licenses/test_licenses_rpc.py b/services/web/server/tests/unit/with_dbs/04/licenses/test_licenses_rpc.py
@@ -172,6 +172,7 @@ async def test_license_checkout_workflow(
             licensed_item_to_resource.insert().values(
                 licensed_item_id=_licensed_item_id,
                 licensed_resource_id=got_licensed_resource_duke.licensed_resource_id,
+                product_name=osparc_product_name,
             )
         )
 

Original file line number	Diff line number	Diff line change
`@@ -205,14 +205,17 @@ async def test_licensed_items_domain_listing(`
`205`	`205`	`{`
`206`	`206`	`"licensed_item_id": got_duke1.licensed_item_id,`
`207`	`207`	`"licensed_resource_id": got_licensed_resource_duke1.licensed_resource_id,`
	`208`	`+ "product_name": osparc_product_name,`
`208`	`209`	`},`
`209`	`210`	`{`
`210`	`211`	`"licensed_item_id": got_duke1.licensed_item_id,`
`211`	`212`	`"licensed_resource_id": got_licensed_resource_duke1_different_id.licensed_resource_id,`
	`213`	`+ "product_name": osparc_product_name,`
`212`	`214`	`},`
`213`	`215`	`{`
`214`	`216`	`"licensed_item_id": got_duke2.licensed_item_id,`
`215`	`217`	`"licensed_resource_id": got_licensed_resource_duke2.licensed_resource_id,`
	`218`	`+ "product_name": osparc_product_name,`
`216`	`219`	`},`
`217`	`220`	`],`
`218`	`221`	`)`
Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,7 @@ async def test_licensed_items_listing(`
`86`	`86`	`licensed_item_to_resource.insert().values(`
`87`	`87`	`licensed_item_id=_licensed_item_id,`
`88`	`88`	`licensed_resource_id=got_licensed_resource_duke.licensed_resource_id,`
	`89`	`+ product_name=osparc_product_name,`
`89`	`90`	`)`
`90`	`91`	`)`
`91`	`92`
`@@ -215,6 +216,7 @@ async def test_licensed_items_purchase(`
`215`	`216`	`licensed_item_to_resource.insert().values(`
`216`	`217`	`licensed_item_id=_licensed_item_id,`
`217`	`218`	`licensed_resource_id=got_licensed_resource_duke.licensed_resource_id,`
	`219`	`+ product_name=osparc_product_name,`
`218`	`220`	`)`
`219`	`221`	`)`
`220`	`222`
Original file line number	Diff line number	Diff line change
`@@ -172,6 +172,7 @@ async def test_license_checkout_workflow(`
`172`	`172`	`licensed_item_to_resource.insert().values(`
`173`	`173`	`licensed_item_id=_licensed_item_id,`
`174`	`174`	`licensed_resource_id=got_licensed_resource_duke.licensed_resource_id,`
	`175`	`+ product_name=osparc_product_name,`
`175`	`176`	`)`
`176`	`177`	`)`
`177`	`178`