✨ web-api: new share_project operation (dev) and updates notifications-library (#7431)

Author: pcrespov

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

@@ -7,15 +7,17 @@
 from typing import Annotated
 
 from fastapi import APIRouter, Depends, status
+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 (
-    _ProjectsGroupsBodyParams,
-    _ProjectsGroupsPathParams,
-)
 from simcore_service_webserver.projects._groups_service import ProjectGroupGet
 
 router = APIRouter(
@@ -24,14 +26,30 @@
 )
 
 
+@router.post(
+    "/projects/{project_id}:share",
+    response_model=Envelope[ProjectShareAccepted],
+    status_code=status.HTTP_202_ACCEPTED,
+    responses={
+        status.HTTP_202_ACCEPTED: {
+            "description": "The request to share the project has been accepted, but the actual sharing process has to be confirmd."
+        }
+    },
+)
+async def share_project(
+    _path: Annotated[ProjectPathParams, Depends()],
+    _body: ProjectShare,
+): ...
+
+
 @router.post(
     "/projects/{project_id}/groups/{group_id}",
     response_model=Envelope[ProjectGroupGet],
     status_code=status.HTTP_201_CREATED,
 )
 async def create_project_group(
-    _path: Annotated[_ProjectsGroupsPathParams, Depends()],
-    _body: _ProjectsGroupsBodyParams,
+    _path: Annotated[ProjectsGroupsPathParams, Depends()],
+    _body: ProjectsGroupsBodyParams,
 ): ...
 
 
@@ -47,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,
 ): ...
 
 
@@ -57,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()],
 ): ...

api/specs/web-server/openapi.py

@@ -42,9 +42,9 @@
         "_nih_sparc",
         "_nih_sparc_redirections",
         "_projects",
+        "_projects_access_rights",
         "_projects_comments",
         "_projects_folders",
-        "_projects_groups",
         "_projects_metadata",
         "_projects_nodes",
         "_projects_nodes_pricing_unit",  # after _projects_nodes

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

@@ -10,6 +10,16 @@ class AccessRights(BaseModel):
 
     model_config = ConfigDict(extra="forbid")
 
+    def verify_access_integrity(self):
+        """Helper function that checks extra constraints in access-rights flags"""
+        if self.write and not self.read:
+            msg = "Write access requires read access"
+            raise ValueError(msg)
+        if self.delete and not self.write:
+            msg = "Delete access requires read access"
+            raise ValueError(msg)
+        return self
+
 
 class ExecutableAccessRights(BaseModel):
     write: Annotated[bool, Field(description="can change executable settings")]

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

@@ -0,0 +1,55 @@
+from typing import Annotated, Self
+
+from models_library.groups import GroupID
+from models_library.projects import ProjectID
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    EmailStr,
+    Field,
+    HttpUrl,
+    StringConstraints,
+    model_validator,
+)
+
+from ..access_rights import AccessRights
+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, strip_whitespace=True),
+        Field(description="An optional message from sharer to sharee"),
+    ] = ""
+
+    # Sharing access rights
+    read: bool
+    write: bool
+    delete: bool
+
+    @model_validator(mode="after")
+    def _validate_access_rights(self) -> Self:
+        AccessRights.model_construct(
+            read=self.read, write=self.write, delete=self.delete
+        ).verify_access_integrity()
+        return self
+
+
+class ProjectShareAccepted(OutputSchema):
+    sharee_email: EmailStr
+    confirmation_link: HttpUrl

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

@@ -2,10 +2,18 @@
 
 from models_library.products import ProductName
 
-
 #
 # *Data are models used for rendering
 #
+
+
+@dataclass(frozen=True)
+class JinjaTemplateDbGet:
+    product_name: ProductName
+    name: str
+    content: str
+
+
 @dataclass(frozen=True)
 class UserData:
     first_name: str

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

@@ -7,15 +7,15 @@
 _logger = logging.getLogger(__name__)
 
 
-def create_render_env_from_package(**kwargs):
+def create_render_environment_from_notifications_library(**kwargs) -> Environment:
     return Environment(
         loader=PackageLoader(notifications_library.__name__, "templates"),
         autoescape=select_autoescape(["html", "xml"]),
         **kwargs
     )
 
 
-def create_render_env_from_folder(top_dir: Path):
+def create_render_environment_from_folder(top_dir: Path) -> Environment:
     assert top_dir.exists()  # nosec
     assert top_dir.is_dir()  # nosec
     return Environment(

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

@@ -1,37 +1,52 @@
+from collections.abc import AsyncIterable
+
 import sqlalchemy as sa
 from models_library.products import ProductName
 from models_library.users import UserID
 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):
         assert db_engine is not None  # nosec
         self.db_engine = db_engine
 
-    async def _get(self, query):
-        async with self.db_engine.begin() as conn:
+
+class UsersRepo(_BaseRepo):
+    async def get_user_data(self, user_id: UserID) -> UserData:
+        query = sa.select(
+            # NOTE: careful! privacy applies here!
+            users.c.first_name,
+            users.c.last_name,
+            users.c.email,
+        ).where(users.c.id == user_id)
+        async with pass_or_acquire_connection(self.db_engine) as conn:
             result = await conn.execute(query)
-            return result.first()
+            row = result.one_or_none()
 
+        if row is None:
+            msg = f"User not found {user_id=}"
+            raise ValueError(msg)
 
-class UsersRepo(_BaseRepo):
-    async def get_user_data(self, user_id: UserID):
-        return await self._get(
-            sa.select(
-                users.c.first_name,
-                users.c.last_name,
-                users.c.email,
-            ).where(users.c.id == user_id)
+        return UserData(
+            first_name=row.first_name, last_name=row.last_name, email=row.email
         )
 
 
 class TemplatesRepo(_BaseRepo):
-    async def iter_email_templates(self, product_name: ProductName):
-        async with self.db_engine.begin() as conn:
+    async def iter_email_templates(
+        self, product_name: ProductName
+    ) -> AsyncIterable[JinjaTemplateDbGet]:
+        async with pass_or_acquire_connection(self.db_engine) as conn:
             async for row in await conn.stream(
                 sa.select(
                     jinja2_templates.c.name,
@@ -43,10 +58,14 @@ async def iter_email_templates(self, product_name: ProductName):
                     & (jinja2_templates.c.name.ilike("%.email.%"))
                 )
             ):
-                yield row
+                yield JinjaTemplateDbGet(
+                    product_name=product_name, name=row.name, content=row.content
+                )
 
-    async def iter_product_templates(self, product_name: ProductName):
-        async with self.db_engine.begin() as conn:
+    async def iter_product_templates(
+        self, product_name: ProductName
+    ) -> AsyncIterable[JinjaTemplateDbGet]:
+        async with pass_or_acquire_connection(self.db_engine) as conn:
             async for row in await conn.stream(
                 sa.select(
                     products_to_templates.c.product_name,
@@ -56,4 +75,6 @@ async def iter_product_templates(self, product_name: ProductName):
                 .select_from(products_to_templates.join(jinja2_templates))
                 .where(products_to_templates.c.product_name == product_name)
             ):
-                yield row
+                yield JinjaTemplateDbGet(
+                    product_name=row.product_name, name=row.name, content=row.template
+                )

packages/notifications-library/src/notifications_library/_db.py renamed to packages/notifications-library/src/notifications_library/_repository.py

@@ -10,7 +10,7 @@
 from aiofiles.os import wrap as sync_to_async
 from models_library.products import ProductName
 
-from ._db import TemplatesRepo
+from ._repository import TemplatesRepo
 
 _logger = logging.getLogger(__name__)
 

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

@@ -42,7 +42,9 @@
     render_email_parts,
 )
 from notifications_library._models import ProductData, UserData
-from notifications_library._render import create_render_env_from_package
+from notifications_library._render import (
+    create_render_environment_from_notifications_library,
+)
 from notifications_library.payments import PaymentData
 from pydantic import EmailStr
 from pydantic.json import pydantic_encoder
@@ -65,8 +67,8 @@ def ipinfo(faker: Faker) -> dict[str, Any]:
 
 @pytest.fixture
 def request_form(faker: Faker) -> dict[str, Any]:
-    return AccountRequestInfo(
-        **AccountRequestInfo.model_config["json_schema_extra"]["example"]
+    return AccountRequestInfo.model_validate(
+        AccountRequestInfo.model_json_schema()["example"]
     ).model_dump()
 
 
@@ -126,7 +128,6 @@ def event_extra_data(  # noqa: PLR0911
                 "host": host_url,
                 "link": f"{host_url}?registration={code}",
             }
-
         case "on_reset_password":
             return {
                 "host": host_url,
@@ -187,7 +188,9 @@ async def test_email_event(
     assert product_data.product_name == product_name
 
     parts = render_email_parts(
-        env=create_render_env_from_package(undefined=StrictUndefined),
+        env=create_render_environment_from_notifications_library(
+            undefined=StrictUndefined
+        ),
         event_name=event_name,
         user=user_data,
         product=product_data,
@@ -254,7 +257,9 @@ async def test_email_with_reply_to(
         )
 
     parts = render_email_parts(
-        env=create_render_env_from_package(undefined=StrictUndefined),
+        env=create_render_environment_from_notifications_library(
+            undefined=StrictUndefined
+        ),
         event_name=event_name,
         user=user_data,
         product=product_data,