gets product support group

Author: pcrespov

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

@@ -54,14 +54,53 @@ 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 BasicGroupGet(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_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
+
+    @classmethod
+    def _extract_basic_group_data(cls, group: Group) -> dict:
+        """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",
+            },
+        )
+
+    @classmethod
+    def from_domain_model(cls, group: Group) -> Self:
+        # Adapts these domain models into this schema
+        return cls.model_validate(cls._extract_basic_group_data(group))
+
+
+class GroupGet(BasicGroupGet):
+    access_rights: Annotated[GroupAccessRights, Field(alias="accessRights")]
 
     inclusion_rules: Annotated[
         dict[str, str],
@@ -77,24 +116,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._extract_basic_group_data(group),
                 "access_rights": access_rights,
             }
         )
@@ -136,15 +158,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
@@ -188,7 +201,7 @@ class MyGroupsGet(OutputSchema):
     all: GroupGet
     product: GroupGet | None = None
     support: Annotated[
-        GroupGet | None,
+        BasicGroupGet | None,
         Field(
             description="Group ID of the app support team or None if no support is defined for this product"
         ),
@@ -235,7 +248,7 @@ class MyGroupsGet(OutputSchema):
                     "gid": "2",
                     "label": "Support Team",
                     "description": "The support team of the application",
-                    "accessRights": {"read": False, "write": False, "delete": False},
+                    "thumbnail": "https://placekitten.com/15/15",
                 },
             }
         }
@@ -246,7 +259,7 @@ def from_domain_model(
         cls,
         groups_by_type: GroupsByTypeTuple,
         my_product_group: tuple[Group, AccessRightsDict] | None,
-        my_support_group: tuple[Group, AccessRightsDict] | None,
+        my_support_group: Group | None,
     ) -> Self:
         assert groups_by_type.primary  # nosec
         assert groups_by_type.everyone  # nosec
@@ -263,7 +276,7 @@ def from_domain_model(
                 else None
             ),
             support=(
-                GroupGet.from_domain_model(*my_support_group)
+                BasicGroupGet.from_domain_model(my_support_group)
                 if my_support_group
                 else None
             ),

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

@@ -132,7 +132,7 @@ def from_domain_model(
         my_groups_by_type: GroupsByTypeTuple,
         my_product_group: tuple[Group, AccessRightsDict] | None,
         my_preferences: AggregatedPreferences,
-        my_support_group: tuple[Group, AccessRightsDict] | None,
+        my_support_group: Group | None,
     ) -> Self:
         data = remap_keys(
             my_profile.model_dump(

packages/models-library/tests/test_users.py

@@ -30,9 +30,7 @@ def test_adapter_from_model_to_schema(
         read=False, write=False, delete=False
     )
 
-    my_support_group = groups[4], AccessRightsDict(
-        read=False, write=False, delete=False
-    )
+    my_support_group = groups[4]
 
     my_preferences = {"foo": Preference(default_value=3, value=1)}
 

services/web/server/src/simcore_service_webserver/groups/_groups_rest.py

@@ -50,7 +50,7 @@ async def list_groups(request: web.Request):
     (
         groups_by_type,
         my_product_group,
-        my_support_group,
+        product_support_group,
     ) = await _groups_service.get_user_profile_groups(
         request.app, user_id=req_ctx.user_id, product=product
     )
@@ -59,7 +59,7 @@ async def list_groups(request: web.Request):
     assert groups_by_type.everyone  # nosec
 
     my_groups = MyGroupsGet.from_domain_model(
-        groups_by_type, my_product_group, my_support_group
+        groups_by_type, my_product_group, product_support_group
     )
 
     return envelope_json_response(my_groups)

services/web/server/src/simcore_service_webserver/groups/_groups_service.py

@@ -91,7 +91,7 @@ async def get_user_profile_groups(
     product group, and support group.
 
     Returns:
-        Tuple of (groups_by_type, my_product_group, my_support_group)
+        Tuple of (groups_by_type, my_product_group, product_support_group)
     """
     groups_by_type = await list_user_groups_with_read_access(app, user_id=user_id)
 
@@ -104,14 +104,14 @@ async def get_user_profile_groups(
                 product_gid=product.group_id,
             )
 
-    my_support_group = None
+    product_support_group = None
     if product.support_standard_group_id:  # Support group is optional
         # NOTE: my_support_group can be part of groups_by_type.standard!
-        my_support_group = await get_group_from_gid(
+        product_support_group = await get_group_from_gid(
             app, product.support_standard_group_id
         )
 
-    return groups_by_type, my_product_group, my_support_group
+    return groups_by_type, my_product_group, product_support_group
 
 
 #

services/web/server/src/simcore_service_webserver/users/_controller/rest/users_rest.py

@@ -52,7 +52,7 @@ async def get_my_profile(request: web.Request) -> web.Response:
     (
         groups_by_type,
         my_product_group,
-        my_support_group,
+        product_support_group,
     ) = await groups_service.get_user_profile_groups(
         request.app, user_id=req_ctx.user_id, product=product
     )
@@ -65,7 +65,7 @@ async def get_my_profile(request: web.Request) -> web.Response:
     )
 
     profile = MyProfileRestGet.from_domain_model(
-        my_profile, groups_by_type, my_product_group, preferences, my_support_group
+        my_profile, groups_by_type, my_product_group, preferences, product_support_group
     )
 
     return envelope_json_response(profile)