@sanderegg review: access-rights

Author: pcrespov

api/specs/web-server/_projects_groups.py renamed to api/specs/web-server/_projects_access_rights.py

@@ -7,17 +7,17 @@
 from typing import Annotated
 
 from fastapi import APIRouter, Depends, status
-from models_library.api_schemas_webserver.groups import ProjectShare
+from models_library.api_schemas_webserver.projects_access_rights import (
+    ProjectsGroupsBodyParams,
+    ProjectsGroupsPathParams,
+    ProjectShare,
+    ProjectShareAccepted,
+)
 from models_library.generics import Envelope
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.projects._controller._rest_schemas import (
     ProjectPathParams,
 )
-from simcore_service_webserver.projects._controller.groups_rest import (
-    ProjectShareAccepted,
-    _ProjectsGroupsBodyParams,
-    _ProjectsGroupsPathParams,
-)
 from simcore_service_webserver.projects._groups_service import ProjectGroupGet
 
 router = APIRouter(
@@ -48,8 +48,8 @@ async def share_project(
     status_code=status.HTTP_201_CREATED,
 )
 async def create_project_group(
-    _path: Annotated[_ProjectsGroupsPathParams, Depends()],
-    _body: _ProjectsGroupsBodyParams,
+    _path: Annotated[ProjectsGroupsPathParams, Depends()],
+    _body: ProjectsGroupsBodyParams,
 ): ...
 
 
@@ -65,8 +65,8 @@ async def list_project_groups(_path: Annotated[ProjectPathParams, Depends()]): .
     response_model=Envelope[ProjectGroupGet],
 )
 async def replace_project_group(
-    _path: Annotated[_ProjectsGroupsPathParams, Depends()],
-    _body: _ProjectsGroupsBodyParams,
+    _path: Annotated[ProjectsGroupsPathParams, Depends()],
+    _body: ProjectsGroupsBodyParams,
 ): ...
 
 
@@ -75,5 +75,5 @@ async def replace_project_group(
     status_code=status.HTTP_204_NO_CONTENT,
 )
 async def delete_project_group(
-    _path: Annotated[_ProjectsGroupsPathParams, Depends()],
+    _path: Annotated[ProjectsGroupsPathParams, Depends()],
 ): ...

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

@@ -8,9 +8,7 @@
     AnyUrl,
     BaseModel,
     ConfigDict,
-    EmailStr,
     Field,
-    HttpUrl,
     TypeAdapter,
     ValidationError,
     field_validator,
@@ -385,17 +383,3 @@ class GroupUserUpdate(InputSchema):
             }
         }
     )
-
-
-class ProjectShare(InputSchema):
-    sharee_email: EmailStr
-
-    # sharing access
-    read: bool
-    write: bool
-    delete: bool
-
-
-class ProjectShareAccepted(OutputSchema):
-    sharee_email: EmailStr
-    confirmation_link: HttpUrl

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

@@ -0,0 +1,40 @@
+from typing import Annotated
+
+from models_library.groups import GroupID
+from models_library.projects import ProjectID
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    EmailStr,
+    HttpUrl,
+    StringConstraints,
+)
+
+from ._base import InputSchema, OutputSchema
+
+
+class ProjectsGroupsPathParams(BaseModel):
+    project_id: ProjectID
+    group_id: GroupID
+    model_config = ConfigDict(extra="forbid")
+
+
+class ProjectsGroupsBodyParams(InputSchema):
+    read: bool
+    write: bool
+    delete: bool
+
+
+class ProjectShare(InputSchema):
+    sharee_email: EmailStr
+    sharer_message: Annotated[str, StringConstraints(max_length=500)]
+
+    # sharing access
+    read: bool
+    write: bool
+    delete: bool
+
+
+class ProjectShareAccepted(OutputSchema):
+    sharee_email: EmailStr
+    confirmation_link: HttpUrl

packages/notifications-library/src/notifications_library/_repository.py

@@ -3,16 +3,17 @@
 import sqlalchemy as sa
 from models_library.products import ProductName
 from models_library.users import UserID
-from notifications_library._models import (
-    JinjaTemplateDbGet,
-    UserData,
-)
 from simcore_postgres_database.models.jinja2_templates import jinja2_templates
 from simcore_postgres_database.models.products_to_templates import products_to_templates
 from simcore_postgres_database.models.users import users
 from simcore_postgres_database.utils_repos import pass_or_acquire_connection
 from sqlalchemy.ext.asyncio import AsyncEngine
 
+from ._models import (
+    JinjaTemplateDbGet,
+    UserData,
+)
+
 
 class _BaseRepo:
     def __init__(self, db_engine: AsyncEngine):

services/web/server/src/simcore_service_webserver/projects/_controller/groups_rest.py renamed to services/web/server/src/simcore_service_webserver/projects/_controller/access_rights_rest.py

@@ -1,21 +1,21 @@
 import logging
 
 from aiohttp import web
-from models_library.api_schemas_webserver.groups import (
+from common_library.json_serialization import json_dumps
+from models_library.api_schemas_webserver.projects_access_rights import (
+    ProjectsGroupsBodyParams,
+    ProjectsGroupsPathParams,
     ProjectShare,
     ProjectShareAccepted,
 )
 from models_library.basic_types import IDStr
-from models_library.groups import GroupID
-from models_library.projects import ProjectID
-from pydantic import BaseModel, ConfigDict
+from models_library.generics import Envelope
 from servicelib.aiohttp import status
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
     parse_request_path_parameters_as,
 )
 from servicelib.logging_utils import log_context
-from simcore_service_webserver.login._login_service import envelope_response
 
 from ..._meta import api_version_prefix as VTAG
 from ...application_settings_utils import requires_dev_feature_enabled
@@ -77,25 +77,15 @@ async def share_project(request: web.Request):
             body_params.sharee_email,
         )
 
-        return envelope_response(
-            data=ProjectShareAccepted(confirmation_link=confirmation_link),  # type: ignore
+        return web.json_response(
+            Envelope[ProjectShareAccepted]
+            .from_data({"confirmation_link": confirmation_link})
+            .model_dump(),
+            dumps=json_dumps,
             status=status.HTTP_202_ACCEPTED,
         )
 
 
-class _ProjectsGroupsPathParams(BaseModel):
-    project_id: ProjectID
-    group_id: GroupID
-    model_config = ConfigDict(extra="forbid")
-
-
-class _ProjectsGroupsBodyParams(BaseModel):
-    read: bool
-    write: bool
-    delete: bool
-    model_config = ConfigDict(extra="forbid")
-
-
 @routes.post(
     f"/{VTAG}/projects/{{project_id}}/groups/{{group_id}}", name="create_project_group"
 )
@@ -104,8 +94,8 @@ class _ProjectsGroupsBodyParams(BaseModel):
 @handle_plugin_requests_exceptions
 async def create_project_group(request: web.Request):
     req_ctx = RequestContext.model_validate(request)
-    path_params = parse_request_path_parameters_as(_ProjectsGroupsPathParams, request)
-    body_params = await parse_request_body_as(_ProjectsGroupsBodyParams, request)
+    path_params = parse_request_path_parameters_as(ProjectsGroupsPathParams, request)
+    body_params = await parse_request_body_as(ProjectsGroupsBodyParams, request)
 
     project_groups: ProjectGroupGet = await _groups_service.create_project_group(
         request.app,
@@ -150,8 +140,8 @@ async def list_project_groups(request: web.Request):
 @handle_plugin_requests_exceptions
 async def replace_project_group(request: web.Request):
     req_ctx = RequestContext.model_validate(request)
-    path_params = parse_request_path_parameters_as(_ProjectsGroupsPathParams, request)
-    body_params = await parse_request_body_as(_ProjectsGroupsBodyParams, request)
+    path_params = parse_request_path_parameters_as(ProjectsGroupsPathParams, request)
+    body_params = await parse_request_body_as(ProjectsGroupsBodyParams, request)
 
     new_project_group = await _groups_service.replace_project_group(
         app=request.app,
@@ -175,7 +165,7 @@ async def replace_project_group(request: web.Request):
 @handle_plugin_requests_exceptions
 async def delete_project_group(request: web.Request):
     req_ctx = RequestContext.model_validate(request)
-    path_params = parse_request_path_parameters_as(_ProjectsGroupsPathParams, request)
+    path_params = parse_request_path_parameters_as(ProjectsGroupsPathParams, request)
 
     await _groups_service.delete_project_group(
         app=request.app,

services/web/server/src/simcore_service_webserver/projects/plugin.py

@@ -12,9 +12,9 @@
 from ..constants import APP_SETTINGS_KEY
 from ..rabbitmq import setup_rabbitmq
 from ._controller import (
+    access_rights_rest,
     comments_rest,
     folders_rest,
-    groups_rest,
     metadata_rest,
     nodes_pricing_unit_rest,
     nodes_rest,
@@ -62,7 +62,7 @@ def setup_projects(app: web.Application) -> bool:
     app.router.add_routes(projects_states_rest.routes)
     app.router.add_routes(projects_rest.routes)
     app.router.add_routes(comments_rest.routes)
-    app.router.add_routes(groups_rest.routes)
+    app.router.add_routes(access_rights_rest.routes)
     app.router.add_routes(metadata_rest.routes)
     app.router.add_routes(ports_rest.routes)
     app.router.add_routes(nodes_rest.routes)

services/web/server/tests/unit/with_dbs/02/test_projects_groups_handlers.py

@@ -9,6 +9,9 @@
 
 import pytest
 from aiohttp.test_utils import TestClient
+from models_library.api_schemas_webserver.projects_access_rights import (
+    ProjectShareAccepted,
+)
 from pytest_mock.plugin import MockerFixture
 from pytest_simcore.helpers.assert_checks import assert_status
 from pytest_simcore.helpers.webserver_login import NewUser, UserInfoDict
@@ -271,14 +274,16 @@ async def test_share_project(
         f"{url}",
         json={
             "shareeEmail": "[email protected]",
+            "sharerMessage": "hi there, this is the project we talked about",
             "read": True,
             "write": False,
             "delete": False,
         },
     )
     data, error = await assert_status(resp, status.HTTP_202_ACCEPTED)
-    assert data["shareeEmail"] == "[email protected]"
-    assert data["confirmationLink"]
+    shared = ProjectShareAccepted.model_validate(data)
+    assert shared.sharee_email == "[email protected]"
+    assert shared.confirmation_link
     assert not error
 
     # Verify that only logged_user["primary_gid"] has access to the project