cleanup

Author: pcrespov

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

@@ -132,14 +132,12 @@ def _sanitize_legacy_data(cls, v):
         return None
 
 
-S = TypeVar("S", bound=BaseModel)
+Sc = TypeVar("Sc", bound=BaseModel)
 
 
-def _model_dump_with_mapping(
-    schema: S, field_mapping: dict[str, str]
-) -> dict[str, Any]:
+def _model_dump_with_map(schema: Sc, alias_map: dict[str, str]) -> dict[str, Any]:
     return {
-        field_mapping.get(k, k): v
+        alias_map.get(k, k): v
         for k, v in schema.model_dump(mode="json", exclude_unset=True).items()
     }
 
@@ -150,11 +148,9 @@ class GroupCreate(InputSchema):
     thumbnail: AnyUrl | None = None
 
     def to_model(self) -> OrganizationCreate:
-        data = _model_dump_with_mapping(
+        data = _model_dump_with_map(
             self,
-            {
-                "label": "name",
-            },
+            alias_map={"label": "name"},
         )
         return OrganizationCreate(**data)
 
@@ -165,11 +161,9 @@ class GroupUpdate(InputSchema):
     thumbnail: AnyUrl | None = None
 
     def to_model(self) -> OrganizationUpdate:
-        data = _model_dump_with_mapping(
+        data = _model_dump_with_map(
             self,
-            {
-                "label": "name",
-            },
+            alias_map={"label": "name"},
         )
         return OrganizationUpdate(**data)
 

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

@@ -91,6 +91,7 @@ class OrganizationUpdate(BaseModel):
 
 
 class GroupAtDB(Group):
+    # NOTE: deprecate and use `Group` instead
     model_config = ConfigDict(
         from_attributes=True,
         json_schema_extra={

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

@@ -37,7 +37,7 @@ async def _create_organization(
     group, access_rights = await create_organization(
         app,
         user_id=user_id,
-        new_group_values=OrganizationCreate.model_validate(new_group),
+        create=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

@@ -8,6 +8,7 @@
     OrganizationCreate,
     OrganizationUpdate,
 )
+from models_library.products import ProductName
 from models_library.users import GroupID, UserID
 
 from ..users.api import get_user
@@ -92,7 +93,7 @@ async def create_organization(
     app: web.Application,
     *,
     user_id: UserID,
-    new_group_values: OrganizationCreate,
+    create: OrganizationCreate,
 ) -> tuple[Group, AccessRightsDict]:
     """
     raises GroupNotFoundError
@@ -101,7 +102,7 @@ async def create_organization(
     return await _groups_db.create_user_group(
         app,
         user_id=user_id,
-        new_group_values=new_group_values,
+        create=create,
     )
 
 
@@ -125,7 +126,7 @@ async def update_organization(
     *,
     user_id: UserID,
     group_id: GroupID,
-    new_group_values: OrganizationUpdate,
+    update: OrganizationUpdate,
 ) -> tuple[Group, AccessRightsDict]:
     """
 
@@ -137,7 +138,7 @@ async def update_organization(
         app,
         user_id=user_id,
         gid=group_id,
-        updated_group_values=new_group_values,
+        update=update,
     )
 
 
@@ -164,7 +165,10 @@ async def list_users_in_group(
 
 
 async def get_user_in_group(
-    app: web.Application, user_id: UserID, gid: GroupID, the_user_id_in_group: int
+    app: web.Application,
+    user_id: UserID,
+    gid: GroupID,
+    the_user_id_in_group: UserID,
 ) -> GroupMember:
 
     return await _groups_db.get_user_in_group(
@@ -176,7 +180,7 @@ async def update_user_in_group(
     app: web.Application,
     user_id: UserID,
     gid: GroupID,
-    the_user_id_in_group: int,
+    the_user_id_in_group: UserID,
     access_rights: dict,
 ) -> GroupMember:
     return await _groups_db.update_user_in_group(
@@ -192,7 +196,7 @@ async def delete_user_in_group(
     app: web.Application,
     user_id: UserID,
     gid: GroupID,
-    the_user_id_in_group: int,
+    the_user_id_in_group: UserID,
 ) -> None:
     return await _groups_db.delete_user_in_group(
         app, user_id=user_id, gid=gid, the_user_id_in_group=the_user_id_in_group
@@ -216,7 +220,9 @@ async def auto_add_user_to_groups(app: web.Application, user_id: UserID) -> None
 
 
 async def auto_add_user_to_product_group(
-    app: web.Application, user_id: UserID, product_name: str
+    app: web.Application,
+    user_id: UserID,
+    product_name: ProductName,
 ) -> GroupID:
     return await _groups_db.auto_add_user_to_product_group(
         app, user_id=user_id, product_name=product_name

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

@@ -260,11 +260,9 @@ async def create_user_group(
     connection: AsyncConnection | None = None,
     *,
     user_id: UserID,
-    new_group_values: OrganizationCreate,
+    create: 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)
@@ -275,7 +273,7 @@ async def create_user_group(
         result = await conn.stream(
             # pylint: disable=no-value-for-parameter
             groups.insert()
-            .values(**values)
+            .values(**create.model_dump(mode="json", exclude_unset=True))
             .returning(*_GROUP_COLUMNS)
         )
         row = await result.fetchone()
@@ -303,10 +301,10 @@ async def update_user_group(
     *,
     user_id: UserID,
     gid: GroupID,
-    updated_group_values: OrganizationUpdate,
+    update: OrganizationUpdate,
 ) -> tuple[Group, AccessRightsDict]:
 
-    values = updated_group_values.model_dump(mode="json", exclude_unset=True)
+    values = update.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(

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.to_model(),
+        create=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.to_model(),
+        update=update.to_model(),
     )
 
     updated_group = GroupGet.from_model(group, access_rights)

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

@@ -285,7 +285,7 @@ async def get_group(client: TestClient, user: dict):
     return await create_organization(
         app=client.app,
         user_id=user["id"],
-        new_group_values=OrganizationCreate.model_validate(
+        create=OrganizationCreate.model_validate(
             {"label": uuid4(), "description": uuid4(), "thumbnail": None}
         ),
     )

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

@@ -424,7 +424,7 @@ async def group_where_logged_user_is_the_owner(
     group, _ = await create_organization(
         app=client.app,
         user_id=logged_user["id"],
-        new_group_values=OrganizationCreate.model_validate(
+        create=OrganizationCreate.model_validate(
             {
                 "gid": "6543",
                 "label": f"this is user {logged_user['id']} group",