Add product_name column to projects table 🗃️ (#8682)

Co-authored-by: Copilot <[email protected]>

Author: giancarloromeo

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

@@ -263,6 +263,15 @@ class Project(BaseProjectModel):
         ),
     ] = DEFAULT_FACTORY
 
+    product_name: Annotated[
+        ProductName,
+        Field(
+            description="Product to which the project belongs",
+            alias="productName",
+            examples=["osparc", "s4l"],
+        ),
+    ]
+
     model_config = ConfigDict(
         # NOTE: this is a security measure until we get rid of the ProjectDict variants
         extra="forbid",

packages/models-library/tests/test_projects.py

@@ -27,6 +27,7 @@ def minimal_project(faker: Faker) -> dict[str, Any]:
         "workbench": {},
         "type": "STANDARD",
         "templateType": None,
+        "productName": "osparc",
     }
 
 

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

@@ -0,0 +1,105 @@
+"""Add product_name to projects
+
+Revision ID: ce69cc44246a
+Revises: a85557c02d71
+Create Date: 2025-12-08 14:14:07.573764+00:00
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+from sqlalchemy.dialects import postgresql
+
+# revision identifiers, used by Alembic.
+revision = "ce69cc44246a"
+down_revision = "a85557c02d71"
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.add_column("projects", sa.Column("product_name", sa.String(), nullable=True))
+
+    op.execute(
+        """
+        UPDATE projects
+        SET product_name = ptp.product_name
+        FROM projects_to_products ptp
+        WHERE projects.uuid = ptp.project_uuid
+        """
+    )
+
+    op.alter_column("projects", "product_name", nullable=False)
+
+    op.create_foreign_key(
+        "fk_projects_to_product_name",
+        "projects",
+        "products",
+        ["product_name"],
+        ["name"],
+        onupdate="CASCADE",
+        ondelete="CASCADE",
+    )
+
+    op.drop_table("projects_to_products")
+
+
+def downgrade():
+    op.create_table(
+        "projects_to_products",
+        sa.Column(
+            "project_uuid",
+            sa.String,
+            sa.ForeignKey(
+                "projects.uuid",
+                onupdate="CASCADE",
+                ondelete="CASCADE",
+                name="fk_projects_to_products_product_uuid",
+            ),
+            nullable=False,
+            doc="Project unique ID",
+        ),
+        sa.Column(
+            "product_name",
+            sa.String,
+            sa.ForeignKey(
+                "products.name",
+                onupdate="CASCADE",
+                ondelete="CASCADE",
+                name="fk_projects_to_products_product_name",
+            ),
+            nullable=False,
+            doc="Products unique name",
+        ),
+        # TIME STAMPS ----
+        sa.Column(
+            "created",
+            postgresql.TIMESTAMP(timezone=True),
+            server_default=sa.text("now()"),
+            autoincrement=False,
+            nullable=False,
+        ),
+        sa.Column(
+            "modified",
+            postgresql.TIMESTAMP(timezone=True),
+            server_default=sa.text("now()"),
+            autoincrement=False,
+            nullable=False,
+        ),
+        sa.UniqueConstraint("project_uuid", "product_name"),
+        sa.Index("idx_projects_to_products_product_name", "product_name"),
+    )
+
+    op.execute(
+        """
+        INSERT INTO projects_to_products (project_uuid, product_name, created, modified)
+        SELECT uuid, product_name, NOW(), NOW()
+        FROM projects
+        WHERE product_name IS NOT NULL
+        ON CONFLICT (project_uuid, product_name) DO NOTHING
+        """
+    )
+
+    op.drop_constraint("fk_projects_to_product_name", "projects", type_="foreignkey")
+
+    op.drop_column("projects", "product_name")

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

@@ -123,7 +123,7 @@ class ProjectTemplateType(str, enum.Enum):
         sa.Boolean,
         nullable=False,
         default=False,
-        doc="If true, the project is publicaly accessible via the studies dispatcher (i.e. no registration required)",
+        doc="If true, the project is publicly accessible via the studies dispatcher (i.e. no registration required)",
     ),
     sa.Column(
         "hidden",
@@ -173,7 +173,7 @@ class ProjectTemplateType(str, enum.Enum):
         JSONB,
         nullable=False,
         server_default=sa.text("'{}'::jsonb"),
-        doc="Free JSON with quality assesment based on TSR",
+        doc="Free JSON with quality assessment based on TSR",
     ),
     # DEPRECATED ----------------------------
     sa.Column(
@@ -183,6 +183,18 @@ class ProjectTemplateType(str, enum.Enum):
         server_default=sa.text("'{}'::jsonb"),
         doc="DEPRECATED: Read/write/delete access rights of each group (gid) on this project",
     ),
+    sa.Column(
+        "product_name",
+        sa.String,
+        sa.ForeignKey(
+            "products.name",
+            onupdate=RefActions.CASCADE,
+            ondelete=RefActions.CASCADE,
+            name="fk_projects_to_product_name",
+        ),
+        nullable=False,
+        doc="Product to which this project belongs",
+    ),
     ### INDEXES ----------------------------
     sa.Index(
         "idx_projects_last_change_date_desc",

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

@@ -304,8 +304,12 @@ async def create_fake_project(
 ) -> AsyncIterator[Callable[..., Awaitable[RowProxy]]]:
     created_project_uuids = []
 
-    async def _creator(conn, user: RowProxy, **overrides) -> RowProxy:
-        prj_to_insert = random_project(prj_owner=user.id, **overrides)
+    async def _creator(
+        conn, user: RowProxy, product: RowProxy, **overrides
+    ) -> RowProxy:
+        prj_to_insert = random_project(
+            prj_owner=user.id, product_name=product.name, **overrides
+        )
         result = await conn.execute(
             projects.insert().values(**prj_to_insert).returning(projects)
         )

packages/postgres-database/tests/conftest.py

@@ -9,8 +9,12 @@
 from aiopg.sa.engine import Engine
 from aiopg.sa.result import ResultProxy, RowProxy
 from psycopg2.errors import ForeignKeyViolation
-from pytest_simcore.helpers.faker_factories import random_project, random_user
-from simcore_postgres_database.webserver_models import projects, users
+from pytest_simcore.helpers.faker_factories import (
+    random_product,
+    random_project,
+    random_user,
+)
+from simcore_postgres_database.webserver_models import products, projects, users
 from sqlalchemy import func
 
 
@@ -21,12 +25,35 @@ async def engine(aiopg_engine: Engine):
         await conn.execute(users.insert().values(**random_user()))
         await conn.execute(users.insert().values(**random_user()))
 
-        await conn.execute(projects.insert().values(**random_project(prj_owner=1)))
-        await conn.execute(projects.insert().values(**random_project(prj_owner=2)))
-        await conn.execute(projects.insert().values(**random_project(prj_owner=3)))
+        await conn.execute(
+            products.insert().values(**random_product(name="test-product"))
+        )
+
+        await conn.execute(
+            projects.insert().values(
+                **random_project(prj_owner=1, product_name="test-product")
+            )
+        )
+        await conn.execute(
+            projects.insert().values(
+                **random_project(prj_owner=2, product_name="test-product")
+            )
+        )
+        await conn.execute(
+            projects.insert().values(
+                **random_project(prj_owner=3, product_name="test-product")
+            )
+        )
         with pytest.raises(ForeignKeyViolation):
             await conn.execute(projects.insert().values(**random_project(prj_owner=4)))
 
+        with pytest.raises(ForeignKeyViolation):
+            await conn.execute(
+                projects.insert().values(
+                    **random_project(prj_owner=1, product_name="unknown-product")
+                )
+            )
+
     return aiopg_engine
 
 
@@ -60,7 +87,7 @@ async def test_insert_user(engine):
         assert res.rowcount == 1
         assert len(res.keys()) > 1
 
-        # DIFFERENT betwen .first() and fetchone()
+        # DIFFERENT between .first() and fetchone()
 
         user2: RowProxy = await res.first()
         # Fetch the first row and then close the result set unconditionally.