✨ Support center: extend response model of get profile endpoint with support group info (#8294)

Author: pcrespov

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

@@ -54,14 +54,48 @@ class GroupAccessRights(BaseModel):
     )
 
 
-class GroupGet(OutputSchema):
-    gid: GroupID = Field(..., description="the group ID")
-    label: str = Field(..., description="the group name")
-    description: str = Field(..., description="the group description")
-    thumbnail: AnyUrl | None = Field(
-        default=None, description="url to the group thumbnail"
-    )
-    access_rights: GroupAccessRights = Field(..., alias="accessRights")
+class GroupGetBase(OutputSchema):
+    gid: Annotated[GroupID, Field(description="the group's unique ID")]
+    label: Annotated[str, Field(description="the group's display name")]
+    description: str
+    thumbnail: Annotated[
+        AnyUrl | None, Field(description="a link to the group's thumbnail")
+    ] = None
+
+    @field_validator("thumbnail", mode="before")
+    @classmethod
+    def _sanitize_thumbnail_input(cls, v):
+        if v:
+            # Enforces null if thumbnail is not valid URL or empty
+            with suppress(ValidationError):
+                return TypeAdapter(AnyHttpUrl).validate_python(v)
+        return None
+
+    @classmethod
+    def dump_basic_group_data(cls, group: Group) -> dict:
+        """Helper function to extract common group data for schema conversion"""
+        return remap_keys(
+            group.model_dump(
+                include={
+                    "gid",
+                    "name",
+                    "description",
+                    "thumbnail",
+                },
+                exclude={
+                    "inclusion_rules",  # deprecated
+                },
+                exclude_unset=True,
+                by_alias=False,
+            ),
+            rename={
+                "name": "label",
+            },
+        )
+
+
+class GroupGet(GroupGetBase):
+    access_rights: Annotated[GroupAccessRights, Field(alias="accessRights")]
 
     inclusion_rules: Annotated[
         dict[str, str],
@@ -77,24 +111,7 @@ def from_domain_model(cls, group: Group, access_rights: AccessRightsDict) -> Sel
         # Adapts these domain models into this schema
         return cls.model_validate(
             {
-                **remap_keys(
-                    group.model_dump(
-                        include={
-                            "gid",
-                            "name",
-                            "description",
-                            "thumbnail",
-                        },
-                        exclude={
-                            "inclusion_rules",  # deprecated
-                        },
-                        exclude_unset=True,
-                        by_alias=False,
-                    ),
-                    rename={
-                        "name": "label",
-                    },
-                ),
+                **cls.dump_basic_group_data(group),
                 "access_rights": access_rights,
             }
         )
@@ -136,15 +153,6 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
 
     model_config = ConfigDict(json_schema_extra=_update_json_schema_extra)
 
-    @field_validator("thumbnail", mode="before")
-    @classmethod
-    def _sanitize_legacy_data(cls, v):
-        if v:
-            # Enforces null if thumbnail is not valid URL or empty
-            with suppress(ValidationError):
-                return TypeAdapter(AnyHttpUrl).validate_python(v)
-        return None
-
 
 class GroupCreate(InputSchema):
     label: str
@@ -187,6 +195,12 @@ class MyGroupsGet(OutputSchema):
     organizations: list[GroupGet] | None = None
     all: GroupGet
     product: GroupGet | None = None
+    support: Annotated[
+        GroupGetBase | None,
+        Field(
+            description="Group ID of the app support team or None if no support is defined for this product"
+        ),
+    ] = None
 
     model_config = ConfigDict(
         json_schema_extra={
@@ -225,6 +239,12 @@ class MyGroupsGet(OutputSchema):
                     "description": "Open to all users",
                     "accessRights": {"read": True, "write": False, "delete": False},
                 },
+                "support": {
+                    "gid": "2",
+                    "label": "Support Team",
+                    "description": "The support team of the application",
+                    "thumbnail": "https://placekitten.com/15/15",
+                },
             }
         }
     )
@@ -234,6 +254,7 @@ def from_domain_model(
         cls,
         groups_by_type: GroupsByTypeTuple,
         my_product_group: tuple[Group, AccessRightsDict] | None,
+        product_support_group: Group | None,
     ) -> Self:
         assert groups_by_type.primary  # nosec
         assert groups_by_type.everyone  # nosec
@@ -249,6 +270,13 @@ def from_domain_model(
                 if my_product_group
                 else None
             ),
+            support=(
+                GroupGetBase.model_validate(
+                    GroupGetBase.dump_basic_group_data(product_support_group)
+                )
+                if product_support_group
+                else None
+            ),
         )
 
 

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

@@ -132,6 +132,7 @@ def from_domain_model(
         my_groups_by_type: GroupsByTypeTuple,
         my_product_group: tuple[Group, AccessRightsDict] | None,
         my_preferences: AggregatedPreferences,
+        my_support_group: Group | None,
     ) -> Self:
         data = remap_keys(
             my_profile.model_dump(
@@ -152,7 +153,9 @@ def from_domain_model(
         )
         return cls(
             **data,
-            groups=MyGroupsGet.from_domain_model(my_groups_by_type, my_product_group),
+            groups=MyGroupsGet.from_domain_model(
+                my_groups_by_type, my_product_group, my_support_group
+            ),
             preferences=my_preferences,
         )
 

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

@@ -39,38 +39,51 @@ class Group(BaseModel):
 
     @staticmethod
     def _update_json_schema_extra(schema: JsonDict) -> None:
+        everyone: JsonDict = {
+            "gid": 1,
+            "name": "Everyone",
+            "type": "everyone",
+            "description": "all users",
+            "thumbnail": None,
+        }
+        user: JsonDict = {
+            "gid": 2,
+            "name": "User",
+            "description": "primary group",
+            "type": "primary",
+            "thumbnail": None,
+        }
+        organization: JsonDict = {
+            "gid": 3,
+            "name": "Organization",
+            "description": "standard group",
+            "type": "standard",
+            "thumbnail": None,
+            "inclusionRules": {},
+        }
+        product: JsonDict = {
+            "gid": 4,
+            "name": "Product",
+            "description": "standard group for products",
+            "type": "standard",
+            "thumbnail": None,
+        }
+        support: JsonDict = {
+            "gid": 5,
+            "name": "Support",
+            "description": "support group",
+            "type": "standard",
+            "thumbnail": None,
+        }
+
         schema.update(
             {
                 "examples": [
-                    {
-                        "gid": 1,
-                        "name": "Everyone",
-                        "type": "everyone",
-                        "description": "all users",
-                        "thumbnail": None,
-                    },
-                    {
-                        "gid": 2,
-                        "name": "User",
-                        "description": "primary group",
-                        "type": "primary",
-                        "thumbnail": None,
-                    },
-                    {
-                        "gid": 3,
-                        "name": "Organization",
-                        "description": "standard group",
-                        "type": "standard",
-                        "thumbnail": None,
-                        "inclusionRules": {},
-                    },
-                    {
-                        "gid": 4,
-                        "name": "Product",
-                        "description": "standard group for products",
-                        "type": "standard",
-                        "thumbnail": None,
-                    },
+                    everyone,
+                    user,
+                    organization,
+                    product,
+                    support,
                 ]
             }
         )

packages/models-library/tests/test_users.py

@@ -1,3 +1,4 @@
+import pytest
 from models_library.api_schemas_webserver.users import (
     MyProfileRestGet,
 )
@@ -7,7 +8,11 @@
 from pydantic import TypeAdapter
 
 
-def test_adapter_from_model_to_schema():
+@pytest.mark.parametrize("with_support_group", [True, False])
+@pytest.mark.parametrize("with_standard_groups", [True, False])
+def test_adapter_from_model_to_schema(
+    with_support_group: bool, with_standard_groups: bool
+):
     my_profile = MyProfile.model_validate(MyProfile.model_json_schema()["example"])
 
     groups = TypeAdapter(list[Group]).validate_python(
@@ -17,13 +22,22 @@ def test_adapter_from_model_to_schema():
     ar = AccessRightsDict(read=False, write=False, delete=False)
 
     my_groups_by_type = GroupsByTypeTuple(
-        primary=(groups[1], ar), standard=[(groups[2], ar)], everyone=(groups[0], ar)
+        primary=(groups[1], ar),
+        standard=[(groups[2], ar)] if with_standard_groups else [],
+        everyone=(groups[0], ar),
     )
-    my_product_group = groups[-1], AccessRightsDict(
+    my_product_group = groups[3], AccessRightsDict(
         read=False, write=False, delete=False
     )
+
+    my_support_group = groups[4]
+
     my_preferences = {"foo": Preference(default_value=3, value=1)}
 
     MyProfileRestGet.from_domain_model(
-        my_profile, my_groups_by_type, my_product_group, my_preferences
+        my_profile,
+        my_groups_by_type,
+        my_product_group,
+        my_preferences,
+        my_support_group if with_support_group else None,
     )

packages/pytest-simcore/src/pytest_simcore/faker_products_data.py

@@ -4,9 +4,9 @@
 # pylint: disable=unused-argument
 # pylint: disable=unused-variable
 """
-    Fixtures to produce fake data for a product:
-        - it is self-consistent
-        - granular customization by overriding fixtures
+Fixtures to produce fake data for a product:
+    - it is self-consistent
+    - granular customization by overriding fixtures
 """
 
 from typing import Any
@@ -65,11 +65,25 @@ def bcc_email(request: pytest.FixtureRequest, product_name: ProductName) -> Emai
     )
 
 
+@pytest.fixture
+def support_standard_group_id(faker: Faker) -> int | None:
+    # NOTE: override to change
+    return None
+
+
 @pytest.fixture
 def product(
-    faker: Faker, product_name: ProductName, support_email: EmailStr
+    faker: Faker,
+    product_name: ProductName,
+    support_email: EmailStr,
+    support_standard_group_id: int | None,
 ) -> dict[str, Any]:
-    return random_product(name=product_name, support_email=support_email, fake=faker)
+    return random_product(
+        name=product_name,
+        support_email=support_email,
+        support_standard_group_id=support_standard_group_id,
+        fake=faker,
+    )
 
 
 @pytest.fixture

packages/pytest-simcore/src/pytest_simcore/helpers/faker_factories.py

@@ -256,6 +256,7 @@ def fake_task(**overrides) -> dict[str, Any]:
 def random_product(
     *,
     group_id: int | None = None,
+    support_standard_group_id: int | None = None,
     registration_email_template: str | None = None,
     fake: Faker = DEFAULT_FAKER,
     **overrides,
@@ -302,6 +303,7 @@ def random_product(
         "priority": fake.pyint(0, 10),
         "max_open_studies_per_user": fake.pyint(1, 10),
         "group_id": group_id,
+        "support_standard_group_id": support_standard_group_id,
     }
 
     if ui := fake.random_element(

services/web/server/VERSION

@@ -1 +1 @@
-0.75.0
+0.76.0

services/web/server/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.75.0
+current_version = 0.76.0
 commit = True
 message = services/webserver api version: {current_version} → {new_version}
 tag = False