Merge remote-tracking branch 'upstream/master' into add-celery-routing-queues

Author: giancarloromeo

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/common-library/src/common_library/json_serialization.py

@@ -1,6 +1,6 @@
-""" Helpers for json serialization
-    - built-in json-like API
-    - implemented using orjson, which  performs better. SEE https://github.com/ijl/orjson?tab=readme-ov-file#performance
+"""Helpers for json serialization
+- built-in json-like API
+- implemented using orjson, which  performs better. SEE https://github.com/ijl/orjson?tab=readme-ov-file#performance
 """
 
 import datetime
@@ -118,6 +118,28 @@ def pydantic_encoder(obj: Any) -> Any:
     raise TypeError(msg)
 
 
+def representation_encoder(obj: Any):
+    """
+    A fallback encoder that uses `pydantic_encoder` to serialize objects.
+    If serialization fails, it falls back to using `str(obj)`.
+
+    This is practical for representation purposes, such as logging or debugging.
+
+    Example:
+        >>> from common_library.json_serialization import json_dumps, representation_encoder
+        >>> class CustomObject:
+        ...     def __str__(self):
+        ...         return "CustomObjectRepresentation"
+        >>> obj = CustomObject()
+        >>> json_dumps(obj, default=representation_encoder)
+        '"CustomObjectRepresentation"'
+    """
+    try:
+        return pydantic_encoder(obj)
+    except TypeError:
+        return str(obj)
+
+
 def json_dumps(
     obj: Any,
     *,

packages/common-library/tests/test_errors_classes.py

@@ -13,20 +13,15 @@
 
 
 def test_get_full_class_name():
-    class A(OsparcErrorMixin):
-        ...
+    class A(OsparcErrorMixin): ...
 
-    class B1(A):
-        ...
+    class B1(A): ...
 
-    class B2(A):
-        ...
+    class B2(A): ...
 
-    class C(B2):
-        ...
+    class C(B2): ...
 
-    class B12(B1, ValueError):
-        ...
+    class B12(B1, ValueError): ...
 
     assert B1._get_full_class_name() == "A.B1"
     assert C._get_full_class_name() == "A.B2.C"

packages/common-library/tests/test_json_serialization.py

@@ -13,6 +13,7 @@
     SeparatorTuple,
     json_dumps,
     json_loads,
+    representation_encoder,
 )
 from faker import Faker
 from pydantic import AnyHttpUrl, AnyUrl, BaseModel, Field, HttpUrl, TypeAdapter
@@ -110,3 +111,25 @@ class M(BaseModel):
         http_url=faker.url(),
     )
     json_dumps(obj)
+
+
+def test_json_dumps_with_representation_encoder():
+    class CustomObject:
+        def __str__(self):
+            return "CustomObjectRepresentation"
+
+    class SomeModel(BaseModel):
+        x: int
+
+    obj = {
+        "custom": CustomObject(),
+        "some": SomeModel(x=42),
+    }
+
+    # Using representation_encoder as the default encoder
+    result = json_dumps(obj, default=representation_encoder, indent=1)
+
+    assert (
+        result
+        == '{\n  "custom": "CustomObjectRepresentation",\n  "some": {\n    "x": 42\n  }\n}'
+    )

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(