🐛🗑️ Fixes validation of product vendor ui object and drops unused project_alias ⚠️ (#8266)

pcrespov · web-flow · commit 8d908b27f4b7 · 2025-09-02T10:39:39.000Z
diff --git a/packages/notifications-library/src/notifications_library/_models.py b/packages/notifications-library/src/notifications_library/_models.py
@@ -30,7 +30,6 @@ class SharerData:
 
 @dataclass(frozen=True)
 class ProductUIData:
-    project_alias: str
     logo_url: str | None = (
         None  # default_logo = "https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/static-webserver/client/source/resource/osparc/osparc-white.svg" in base.html
     )
diff --git a/packages/notifications-library/src/notifications_library/templates/on_share_project.email.content.html b/packages/notifications-library/src/notifications_library/templates/on_share_project.email.content.html
@@ -3,9 +3,9 @@
 {% block content %}
 <p>Dear {{ user.first_name or user.user_name }},</p>
 
-<p>Great news! {{ sharer.user_name }} has shared a {{ product.ui.project_alias }} with you on {{ product.display_name }}.</p>
+<p>Great news! {{ sharer.user_name }} has shared a project with you on {{ product.display_name }}.</p>
 
-<p>To view the {{ product.ui.project_alias }} and accept the sharing, follow below:</p>
+<p>To view the project and accept the sharing, follow below:</p>
 
 <p>
 {% if sharer.message %}
diff --git a/packages/notifications-library/src/notifications_library/templates/on_share_project.email.content.txt b/packages/notifications-library/src/notifications_library/templates/on_share_project.email.content.txt
@@ -1,8 +1,8 @@
 Dear {{ user.first_name or user.user_name }},
 
-Great news! {{ sharer.user_name }} has shared a {{ product.ui.project_alias }} with you on {{ product.display_name }}.
+Great news! {{ sharer.user_name }} has shared a project with you on {{ product.display_name }}.
 
-To view the {{ product.ui.project_alias }} and accept the sharing, follow below:
+To view the project and accept the sharing, follow below:
 
 {{ sharer.message }}
 {{ accept_link }}
diff --git a/packages/notifications-library/src/notifications_library/templates/on_share_project.email.subject.txt b/packages/notifications-library/src/notifications_library/templates/on_share_project.email.subject.txt
@@ -1 +1 @@
-A {{ product.ui.project_alias }} was shared with you on {{ host }}
+A project was shared with you on {{ host }}
diff --git a/packages/notifications-library/tests/conftest.py b/packages/notifications-library/tests/conftest.py
@@ -66,7 +66,6 @@ def product_data(
     product_ui = ProductUIData(
         logo_url=vendor_ui.get("logo_url"),
         strong_color=vendor_ui.get("strong_color"),
-        project_alias=vendor_ui["project_alias"],
     )
 
     return ProductData(  # type: ignore
diff --git a/packages/postgres-database/src/simcore_postgres_database/models/products.py b/packages/postgres-database/src/simcore_postgres_database/models/products.py
@@ -32,7 +32,6 @@
 class VendorUI(TypedDict, total=True):
     logo_url: str  # vendor logo url
     strong_color: str  # vendor main color
-    project_alias: str  # project alias for the product (e.g. "project" or "study")
 
 
 class Vendor(TypedDict, total=False):
diff --git a/packages/postgres-database/src/simcore_postgres_database/utils_users.py b/packages/postgres-database/src/simcore_postgres_database/utils_users.py
@@ -172,7 +172,9 @@ async def link_and_update_user_from_pre_registration(
             pre_columns = (
                 users_pre_registration_details.c.pre_first_name,
                 users_pre_registration_details.c.pre_last_name,
-                # NOTE: pre_phone is not copied since it has to be validated.
+                # NOTE: pre_phone is NOT copied since it has to be validated.
+                # It remains here as informative. In the future it might be given
+                # as a hint to the front end?
                 # Otherwise, if phone is wrong, currently user won't be able to login!
             )
 
diff --git a/packages/pytest-simcore/src/pytest_simcore/helpers/faker_factories.py b/packages/pytest-simcore/src/pytest_simcore/helpers/faker_factories.py
@@ -294,7 +294,6 @@ def random_product(
             ui=VendorUI(
                 logo_url="https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/static-webserver/client/source/resource/osparc/osparc-black.svg",
                 strong_color=fake.color(),
-                project_alias=fake.random_element(elements=["project", "study"]),
             ),
         ),
         "registration_email_template": registration_email_template,
diff --git a/services/web/server/src/simcore_service_webserver/products/_models.py b/services/web/server/src/simcore_service_webserver/products/_models.py
@@ -12,7 +12,6 @@
 from models_library.basic_types import NonNegativeDecimal
 from models_library.emails import LowerCaseEmailStr
 from models_library.products import ProductName, StripePriceID, StripeTaxRateID
-from models_library.utils.change_case import snake_to_camel
 from pydantic import (
     BaseModel,
     BeforeValidator,
@@ -256,7 +255,6 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
                             "ui": {
                                 "logo_url": "https://acme.com/logo",
                                 "strong_color": "#123456",
-                                "project_alias": "study",
                             },
                         },
                         "issues": [
@@ -306,13 +304,13 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
         )
 
     model_config = ConfigDict(
-        alias_generator=snake_to_camel,
-        populate_by_name=True,
-        str_strip_whitespace=True,
-        frozen=True,
+        # NOTE: do not add aliases. Use ProductGet schema for rest API
         from_attributes=True,
-        extra="ignore",
+        frozen=True,
         json_schema_extra=_update_json_schema_extra,
+        str_strip_whitespace=True,
+        validate_by_name=True,
+        extra="ignore",
     )
 
     def to_statics(self) -> dict[str, Any]:
@@ -337,13 +335,12 @@ def to_statics(self) -> dict[str, Any]:
             },
             exclude_none=True,
             exclude_unset=True,
-            by_alias=True,
         )
 
     def get_template_name_for(self, filename: str) -> str | None:
         """Checks for field marked with 'x_template_name' that fits the argument"""
         template_name = filename.removesuffix(".jinja2")
-        for name, field in self.model_fields.items():
+        for name, field in self.__class__.model_fields.items():
             if (
                 field.json_schema_extra
                 and field.json_schema_extra.get("x_template_name") == template_name  # type: ignore[union-attr]
diff --git a/services/web/server/src/simcore_service_webserver/products/_repository.py b/services/web/server/src/simcore_service_webserver/products/_repository.py
@@ -63,7 +63,7 @@
 )
 
 
-def _to_domain(products_row: Row, payments: PaymentFields) -> Product:
+def _db_to_domain(products_row: Row, payments: PaymentFields) -> Product:
     return Product(
         **products_row._asdict(),
         is_payment_enabled=payments.enabled,
@@ -115,7 +115,7 @@ async def list_products(
             async for row in rows:
                 name = row.name
                 payments = await _get_product_payment_fields(conn, product_name=name)
-                app_products.append(_to_domain(row, payments))
+                app_products.append(_db_to_domain(row, payments))
 
                 assert name in FRONTEND_APPS_AVAILABLE  # nosec
 
@@ -142,7 +142,7 @@ async def get_product(
                 payments = await _get_product_payment_fields(
                     conn, product_name=row.name
                 )
-                return _to_domain(row, payments)
+                return _db_to_domain(row, payments)
             return None
 
     async def get_default_product_name(
diff --git a/services/web/server/src/simcore_service_webserver/statics/_events.py b/services/web/server/src/simcore_service_webserver/statics/_events.py
@@ -7,6 +7,7 @@
 from aiohttp.client import ClientSession
 from aiohttp.client_exceptions import ClientConnectionError, ClientError
 from common_library.json_serialization import json_dumps
+from models_library.utils.change_case import snake_to_camel
 from packaging.version import Version
 from servicelib.aiohttp.client_session import get_client_session
 from tenacity.asyncio import AsyncRetrying
@@ -99,6 +100,10 @@ def _get_release_notes_vtag(vtag: str) -> str:
     return f"v{version.major}.{version.minor}.0"
 
 
+def _get_product_data(product: Product) -> dict[str, Any]:
+    return {snake_to_camel(k): v for k, v in product.to_statics().items()}
+
+
 async def create_and_cache_statics_json(app: web.Application) -> None:
     # NOTE: in devel model, the folder might be under construction
     # (qx-compile takes time), therefore we create statics.json
@@ -122,7 +127,8 @@ async def create_and_cache_statics_json(app: web.Application) -> None:
         data = deepcopy(common)
 
         _logger.debug("Product %s", product.name)
-        data.update(product.to_statics())
+
+        data.update(_get_product_data(product))
 
         # Adds specifics to login settings
         if (p := product.login_settings) and (v := p.get("LOGIN_2FA_REQUIRED", None)):
diff --git a/services/web/server/src/simcore_service_webserver/users/_accounts_service.py b/services/web/server/src/simcore_service_webserver/users/_accounts_service.py
@@ -329,13 +329,8 @@ def _create_product_and_user_data(
         else "IT'IS Foundation"
     )
 
-    # Extract UI information
+    # Extract UI information from product.vendor.ui (optional)
     ui_data = ProductUIData(
-        project_alias=(
-            product.vendor.get("ui", {}).get("project_alias") or "study"
-            if product.vendor
-            else "study"
-        ),
         logo_url=(
             product.vendor.get("ui", {}).get("logo_url") if product.vendor else None
         ),
diff --git a/services/web/server/tests/unit/isolated/products/test_products_model.py b/services/web/server/tests/unit/isolated/products/test_products_model.py
@@ -21,6 +21,7 @@
 )
 from simcore_postgres_database.models.products import products as products_table
 from simcore_service_webserver.products.models import Product
+from simcore_service_webserver.statics._events import _get_product_data
 
 
 @pytest.mark.parametrize(
@@ -40,18 +41,24 @@ def test_all_products_models_examples(
         if "registration_email_template" in example_data:
             assert model_instance.get_template_name_for("registration_email.jinja2")
 
+        if model_instance.vendor and "ui" in model_instance.vendor:
+            assert model_instance.vendor["ui"]["strong_color"]
+            assert model_instance.vendor["ui"]["logo_url"]
+
 
 def test_product_to_static():
 
     product = Product.model_validate(Product.model_json_schema()["examples"][0])
-    assert product.to_statics() == {
+    product_data = _get_product_data(product)
+    assert product_data == {
         "displayName": "o²S²PARC",
         "supportEmail": "support@osparc.io",
     }
 
     product = Product.model_validate(Product.model_json_schema()["examples"][2])
 
-    assert product.to_statics() == {
+    product_data = _get_product_data(product)
+    assert product_data == {
         "displayName": "o²S²PARC FOO",
         "supportEmail": "foo@osparcf.io",
         "vendor": {
@@ -63,7 +70,6 @@ def test_product_to_static():
             "ui": {
                 "logo_url": "https://acme.com/logo",
                 "strong_color": "#123456",
-                "project_alias": "study",
             },
         },
         "issues": [

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,6 @@ class SharerData:`
`30`	`30`
`31`	`31`	`@dataclass(frozen=True)`
`32`	`32`	`class ProductUIData:`
`33`		`- project_alias: str`
`34`	`33`	`logo_url: str \| None = (`
`35`	`34`	`None # default_logo = "https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/refs/heads/master/services/static-webserver/client/source/resource/osparc/osparc-white.svg" in base.html`
`36`	`35`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-A {{ product.ui.project_alias }} was shared with you on {{ host }}`
	`1`	`+A project was shared with you on {{ host }}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,6 @@ def product_data(`
`66`	`66`	`product_ui = ProductUIData(`
`67`	`67`	`logo_url=vendor_ui.get("logo_url"),`
`68`	`68`	`strong_color=vendor_ui.get("strong_color"),`
`69`		`- project_alias=vendor_ui["project_alias"],`
`70`	`69`	`)`
`71`	`70`
`72`	`71`	`return ProductData( # type: ignore`