models for organizations

Author: pcrespov

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

@@ -1,5 +1,6 @@
+from ast import TypeVar
 from contextlib import suppress
-from typing import Annotated, Self
+from typing import Annotated, Any, Self
 
 from common_library.basic_types import DEFAULT_FACTORY
 from pydantic import (
@@ -16,7 +17,7 @@
 
 from ..basic_types import IDStr
 from ..emails import LowerCaseEmailStr
-from ..groups import AccessRightsDict, Group
+from ..groups import AccessRightsDict, Group, OrganizationCreate, OrganizationUpdate
 from ..users import UserID
 from ..utils.common_validators import create__check_only_one_is_set__root_validator
 from ._base import InputSchema, OutputSchema
@@ -131,17 +132,47 @@ def _sanitize_legacy_data(cls, v):
         return None
 
 
+S = TypeVar("S", bound=BaseModel)
+
+
+def _model_dump_with_mapping(
+    schema: S, field_mapping: dict[str, str]
+) -> dict[str, Any]:
+    return {
+        field_mapping.get(k, k): v
+        for k, v in schema.model_dump(mode="json", exclude_unset=True).items()
+    }
+
+
 class GroupCreate(InputSchema):
     label: str
     description: str
     thumbnail: AnyUrl | None = None
 
+    def to_model(self) -> OrganizationCreate:
+        data = _model_dump_with_mapping(
+            self,
+            {
+                "label": "name",
+            },
+        )
+        return OrganizationCreate(**data)
+
 
 class GroupUpdate(InputSchema):
     label: str | None = None
     description: str | None = None
     thumbnail: AnyUrl | None = None
 
+    def to_model(self) -> OrganizationUpdate:
+        data = _model_dump_with_mapping(
+            self,
+            {
+                "label": "name",
+            },
+        )
+        return OrganizationUpdate(**data)
+
 
 class MyGroupsGet(OutputSchema):
     me: GroupGet

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

@@ -78,6 +78,18 @@ class GroupMember(BaseModel):
     model_config = ConfigDict(from_attributes=True)
 
 
+class OrganizationCreate(BaseModel):
+    name: str
+    description: str | None
+    thumbnail: str | None
+
+
+class OrganizationUpdate(BaseModel):
+    name: str | None
+    description: str | None
+    thumbnail: str | None
+
+
 class GroupAtDB(Group):
     model_config = ConfigDict(
         from_attributes=True,

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

@@ -16,7 +16,7 @@
 from aiohttp import web
 from aiohttp.test_utils import TestClient
 from models_library.api_schemas_webserver.groups import GroupGet
-from models_library.groups import GroupsByTypeTuple
+from models_library.groups import GroupsByTypeTuple, OrganizationCreate
 from models_library.users import UserID
 from pytest_simcore.helpers.webserver_login import NewUser, UserInfoDict
 from simcore_service_webserver.groups._groups_api import (
@@ -35,7 +35,9 @@ async def _create_organization(
     app: web.Application, user_id: UserID, new_group: dict
 ) -> dict[str, Any]:
     group, access_rights = await create_organization(
-        app, user_id=user_id, new_group_values=new_group
+        app,
+        user_id=user_id,
+        new_group_values=OrganizationCreate.model_validate(new_group),
     )
     return _groupget_model_dump(group=group, access_rights=access_rights)
 

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

@@ -5,6 +5,8 @@
     Group,
     GroupMember,
     GroupsByTypeTuple,
+    OrganizationCreate,
+    OrganizationUpdate,
 )
 from models_library.users import GroupID, UserID
 
@@ -87,14 +89,19 @@ async def get_product_group_for_user(
 
 
 async def create_organization(
-    app: web.Application, *, user_id: UserID, new_group_values: dict
+    app: web.Application,
+    *,
+    user_id: UserID,
+    new_group_values: OrganizationCreate,
 ) -> tuple[Group, AccessRightsDict]:
     """
     raises GroupNotFoundError
     raises UserInsufficientRightsError
     """
     return await _groups_db.create_user_group(
-        app, user_id=user_id, new_group=new_group_values
+        app,
+        user_id=user_id,
+        new_group_values=new_group_values,
     )
 
 
@@ -118,15 +125,19 @@ async def update_organization(
     *,
     user_id: UserID,
     group_id: GroupID,
-    new_group_values: dict[str, str],
+    new_group_values: OrganizationUpdate,
 ) -> tuple[Group, AccessRightsDict]:
     """
 
     raises GroupNotFoundError
     raises UserInsufficientRightsError
     """
+
     return await _groups_db.update_user_group(
-        app, user_id=user_id, gid=group_id, new_group_values=new_group_values
+        app,
+        user_id=user_id,
+        gid=group_id,
+        updated_group_values=new_group_values,
     )
 
 

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

@@ -9,6 +9,8 @@
     GroupInfoTuple,
     GroupMember,
     GroupsByTypeTuple,
+    OrganizationCreate,
+    OrganizationUpdate,
 )
 from models_library.users import GroupID, UserID
 from simcore_postgres_database.errors import UniqueViolation
@@ -25,7 +27,6 @@
 from ..db.models import GroupType, groups, user_to_groups, users
 from ..db.plugin import get_asyncpg_engine
 from ..users.exceptions import UserNotFoundError
-from ._utils import convert_groups_schema_to_db
 from .exceptions import (
     GroupNotFoundError,
     UserAlreadyInGroupError,
@@ -251,25 +252,30 @@ async def get_product_group_for_user(
         return group, access_rights
 
 
+assert set(OrganizationCreate.model_fields).issubset({c.name for c in groups.columns})
+
+
 async def create_user_group(
     app: web.Application,
     connection: AsyncConnection | None = None,
     *,
     user_id: UserID,
-    new_group: dict,
+    new_group_values: OrganizationCreate,
 ) -> tuple[Group, AccessRightsDict]:
+
+    values = new_group_values.model_dump(mode="json", exclude_unset=True)
+
     async with transaction_context(get_asyncpg_engine(app), connection) as conn:
         result = await conn.stream(
             sa.select(users.c.primary_gid).where(users.c.id == user_id)
         )
-        user = await result.fetchone()
-        if not user:
+        if not await result.scalar_one_or_none():
             raise UserNotFoundError(uid=user_id)
 
         result = await conn.stream(
             # pylint: disable=no-value-for-parameter
             groups.insert()
-            .values(**convert_groups_schema_to_db(new_group))
+            .values(**values)
             .returning(*_GROUP_COLUMNS)
         )
         row = await result.fetchone()
@@ -288,20 +294,21 @@ async def create_user_group(
         return group, deepcopy(_DEFAULT_GROUP_OWNER_ACCESS_RIGHTS)
 
 
+assert set(OrganizationUpdate.model_fields).issubset({c.name for c in groups.columns})
+
+
 async def update_user_group(
     app: web.Application,
     connection: AsyncConnection | None = None,
     *,
     user_id: UserID,
     gid: GroupID,
-    new_group_values: dict[str, str],
+    updated_group_values: OrganizationUpdate,
 ) -> tuple[Group, AccessRightsDict]:
 
-    async with transaction_context(get_asyncpg_engine(app), connection) as conn:
-        new_values = {
-            k: v for k, v in convert_groups_schema_to_db(new_group_values).items() if v
-        }
+    values = updated_group_values.model_dump(mode="json", exclude_unset=True)
 
+    async with transaction_context(get_asyncpg_engine(app), connection) as conn:
         row = await _get_group_and_access_rights_or_raise(
             conn, user_id=user_id, gid=gid
         )
@@ -312,7 +319,7 @@ async def update_user_group(
         result = await conn.stream(
             # pylint: disable=no-value-for-parameter
             groups.update()
-            .values(**new_values)
+            .values(**values)
             .where(groups.c.gid == row.gid)
             .returning(*_GROUP_COLUMNS)
         )

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

@@ -112,7 +112,7 @@ async def create_group(request: web.Request):
     group, access_rights = await _groups_api.create_organization(
         request.app,
         user_id=req_ctx.user_id,
-        new_group_values=create.model_dump(mode="json", exclude_unset=True),
+        new_group_values=create.to_model(),
     )
 
     created_group = GroupGet.from_model(group, access_rights)
@@ -133,7 +133,7 @@ async def update_group(request: web.Request):
         request.app,
         user_id=req_ctx.user_id,
         group_id=path_params.gid,
-        new_group_values=update.model_dump(exclude_unset=True),
+        new_group_values=update.to_model(),
     )
 
     updated_group = GroupGet.from_model(group, access_rights)

services/web/server/tests/integration/01/test_garbage_collection.py

@@ -21,7 +21,7 @@
 from aiohttp import web
 from aiohttp.test_utils import TestClient
 from aioresponses import aioresponses
-from models_library.groups import EVERYONE_GROUP_ID
+from models_library.groups import EVERYONE_GROUP_ID, OrganizationCreate
 from models_library.projects_state import RunningState
 from pytest_mock import MockerFixture
 from pytest_simcore.helpers.webserver_login import UserInfoDict, log_client_in
@@ -285,7 +285,9 @@ async def get_group(client: TestClient, user: dict):
     return await create_organization(
         app=client.app,
         user_id=user["id"],
-        new_group_values={"label": uuid4(), "description": uuid4(), "thumbnail": None},
+        new_group_values=OrganizationCreate.model_validate(
+            {"label": uuid4(), "description": uuid4(), "thumbnail": None}
+        ),
     )
 
 

services/web/server/tests/unit/with_dbs/01/groups/test_groups_handlers_users.py

@@ -11,7 +11,7 @@
 from aiohttp.test_utils import TestClient
 from faker import Faker
 from models_library.api_schemas_webserver.groups import GroupGet, GroupUserGet
-from models_library.groups import AccessRightsDict, Group
+from models_library.groups import AccessRightsDict, Group, OrganizationCreate
 from pytest_simcore.helpers.assert_checks import assert_status
 from pytest_simcore.helpers.webserver_login import LoggedUser, NewUser, UserInfoDict
 from pytest_simcore.helpers.webserver_parametrizations import (
@@ -424,12 +424,14 @@ async def group_where_logged_user_is_the_owner(
     group, _ = await create_organization(
         app=client.app,
         user_id=logged_user["id"],
-        new_group_values={
-            "gid": "6543",
-            "label": f"this is user {logged_user['id']} group",
-            "description": f"user {logged_user['email']} is the owner of that one",
-            "thumbnail": None,
-        },
+        new_group_values=OrganizationCreate.model_validate(
+            {
+                "gid": "6543",
+                "label": f"this is user {logged_user['id']} group",
+                "description": f"user {logged_user['email']} is the owner of that one",
+                "thumbnail": None,
+            }
+        ),
     )
 
     yield group