Merge branch 'master' into is6880/hash-api-key-secret

Author: giancarloromeo

api/specs/web-server/_long_running_tasks.py

@@ -13,7 +13,7 @@
 from servicelib.long_running_tasks._models import TaskGet, TaskStatus
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.tasks._exception_handlers import (
-    _TO_HTTP_ERROR_MAP as data_export_http_error_map,
+    _TO_HTTP_ERROR_MAP as export_data_http_error_map,
 )
 
 router = APIRouter(
@@ -23,9 +23,9 @@
     ],
 )
 
-_data_export_responses: dict[int | str, dict[str, Any]] = {
+_export_data_responses: dict[int | str, dict[str, Any]] = {
     i.status_code: {"model": EnvelopedError}
-    for i in data_export_http_error_map.values()
+    for i in export_data_http_error_map.values()
 }
 
 
@@ -34,7 +34,7 @@
     response_model=Envelope[list[TaskGet]],
     name="list_tasks",
     description="Lists all long running tasks",
-    responses=_data_export_responses,
+    responses=_export_data_responses,
 )
 def get_async_jobs(): ...
 
@@ -44,7 +44,7 @@ def get_async_jobs(): ...
     response_model=Envelope[TaskStatus],
     name="get_task_status",
     description="Retrieves the status of a task",
-    responses=_data_export_responses,
+    responses=_export_data_responses,
 )
 def get_async_job_status(
     _path_params: Annotated[_PathParam, Depends()],
@@ -55,7 +55,7 @@ def get_async_job_status(
     "/tasks/{task_id}",
     name="cancel_and_delete_task",
     description="Cancels and deletes a task",
-    responses=_data_export_responses,
+    responses=_export_data_responses,
     status_code=status.HTTP_204_NO_CONTENT,
 )
 def abort_async_job(
@@ -67,7 +67,7 @@ def abort_async_job(
     "/tasks/{task_id}/result",
     name="get_task_result",
     description="Retrieves the result of a task",
-    responses=_data_export_responses,
+    responses=_export_data_responses,
 )
 def get_async_job_result(
     _path_params: Annotated[_PathParam, Depends()],

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/_storage.py

@@ -36,7 +36,7 @@
 from simcore_service_webserver._meta import API_VTAG
 from simcore_service_webserver.storage.schemas import DatasetMetaData, FileMetaData
 from simcore_service_webserver.tasks._exception_handlers import (
-    _TO_HTTP_ERROR_MAP as data_export_http_error_map,
+    _TO_HTTP_ERROR_MAP as export_data_http_error_map,
 )
 
 router = APIRouter(
@@ -221,9 +221,9 @@ async def is_completed_upload_file(
 
 
 # data export
-_data_export_responses: dict[int | str, dict[str, Any]] = {
+_export_data_responses: dict[int | str, dict[str, Any]] = {
     i.status_code: {"model": EnvelopedError}
-    for i in data_export_http_error_map.values()
+    for i in export_data_http_error_map.values()
 }
 
 
@@ -232,7 +232,7 @@ async def is_completed_upload_file(
     response_model=Envelope[TaskGet],
     name="export_data",
     description="Export data",
-    responses=_data_export_responses,
+    responses=_export_data_responses,
 )
-async def export_data(data_export: DataExportPost, location_id: LocationID):
+async def export_data(export_data: DataExportPost, location_id: LocationID):
     """Trigger data export. Returns async job id for getting status and results"""

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/aws-library/src/aws_library/ec2/_error_handler.py

@@ -59,13 +59,8 @@ def ec2_exception_handler(
     [Callable[Concatenate[Self, P], Coroutine[Any, Any, R]]],
     Callable[Concatenate[Self, P], Coroutine[Any, Any, R]],
 ]:
-    """
-    Raises:
-        SSMAccessError:
-    """
-
     def decorator(
-        func: Callable[Concatenate[Self, P], Coroutine[Any, Any, R]]
+        func: Callable[Concatenate[Self, P], Coroutine[Any, Any, R]],
     ) -> Callable[Concatenate[Self, P], Coroutine[Any, Any, R]]:
         @functools.wraps(func)
         async def wrapper(self: Self, *args: P.args, **kwargs: P.kwargs) -> R:

packages/aws-library/src/aws_library/s3/_constants.py

@@ -9,6 +9,9 @@
 MULTIPART_COPY_THRESHOLD: Final[ByteSize] = TypeAdapter(ByteSize).validate_python(
     "100MiB"
 )
+STREAM_READER_CHUNK_SIZE: Final[ByteSize] = TypeAdapter(ByteSize).validate_python(
+    "10MiB"
+)
 
 PRESIGNED_LINK_MAX_SIZE: Final[ByteSize] = TypeAdapter(ByteSize).validate_python("5GiB")
 S3_MAX_FILE_SIZE: Final[ByteSize] = TypeAdapter(ByteSize).validate_python("5TiB")

packages/aws-library/tests/test_s3_client.py

@@ -27,8 +27,8 @@
 from aiohttp import ClientSession
 from aws_library.s3._client import _AWS_MAX_ITEMS_PER_PAGE, S3ObjectKey, SimcoreS3API
 from aws_library.s3._constants import (
-    MULTIPART_COPY_THRESHOLD,
     MULTIPART_UPLOADS_MIN_TOTAL_SIZE,
+    STREAM_READER_CHUNK_SIZE,
 )
 from aws_library.s3._errors import (
     S3BucketInvalidError,
@@ -1902,7 +1902,7 @@ async def test_workflow_compress_s3_objects_and_local_files_in_a_single_archive_
                 get_zip_bytes_iter(
                     archive_entries,
                     progress_bar=progress_bar,
-                    chunk_size=MULTIPART_COPY_THRESHOLD,
+                    chunk_size=STREAM_READER_CHUNK_SIZE,
                 )
             ),
         )

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_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")]