🎨 [Frontend] Enh: Show who is collaborating

api/specs/web-server/_projects_states.py

@@ -7,9 +7,11 @@
 from typing import Annotated
 
 from fastapi import APIRouter, Body, Depends
-from models_library.api_schemas_webserver.projects import ProjectGet
+from models_library.api_schemas_webserver.projects import (
+    ProjectGet,
+    ProjectStateOutputSchema,
+)
 from models_library.generics import Envelope
-from models_library.projects_state import ProjectState
 from pydantic import ValidationError
 from servicelib.aiohttp import status
 from simcore_service_webserver._meta import API_VTAG
@@ -80,7 +82,9 @@ def close_project(
 ): ...
 
 
-@router.get("/projects/{project_id}/state", response_model=Envelope[ProjectState])
+@router.get(
+    "/projects/{project_id}/state", response_model=Envelope[ProjectStateOutputSchema]
+)
 def get_project_state(
     _path_params: Annotated[ProjectPathParams, Depends()],
 ): ...

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

@@ -35,7 +35,12 @@
     ProjectType,
 )
 from ..projects_access import AccessRights, GroupIDStr
-from ..projects_state import ProjectState
+from ..projects_state import (
+    ProjectShareCurrentUserGroupIDs,
+    ProjectShareLocked,
+    ProjectShareStatus,
+    ProjectStateRunningState,
+)
 from ..utils._original_fastapi_encoders import jsonable_encoder
 from ..utils.common_validators import (
     empty_str_to_none_pre_validator,
@@ -105,6 +110,17 @@ def to_domain_model(self) -> dict[str, Any]:
         )
 
 
+class ProjectShareStateOutputSchema(OutputSchema):
+    status: ProjectShareStatus
+    locked: ProjectShareLocked
+    current_user_groupids: ProjectShareCurrentUserGroupIDs
+
+
+class ProjectStateOutputSchema(OutputSchema):
+    share_state: ProjectShareStateOutputSchema
+    state: ProjectStateRunningState
+
+
 class ProjectGet(OutputSchema):
     uuid: ProjectID
 
@@ -124,7 +140,7 @@ class ProjectGet(OutputSchema):
     # state
     creation_date: DateTimeStr
     last_change_date: DateTimeStr
-    state: ProjectState | None = None
+    state: ProjectStateOutputSchema | None = None
     trashed_at: datetime | None
     trashed_by: Annotated[
         GroupID | None, Field(description="The primary gid of the user who trashed")

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

@@ -3,7 +3,7 @@
 """
 
 from enum import Enum, unique
-from typing import Annotated
+from typing import Annotated, Self, TypeAlias
 
 from pydantic import (
     BaseModel,
@@ -13,7 +13,9 @@
     field_validator,
     model_validator,
 )
+from pydantic.config import JsonDict
 
+from .groups import GroupID
 from .projects_access import Owner
 
 
@@ -77,7 +79,101 @@ class ProjectStatus(str, Enum):
     EXPORTING = "EXPORTING"
     OPENING = "OPENING"
     OPENED = "OPENED"
-    MAINTAINING = "MAINTAINING"
+    MAINTAINING = "MAINTAINING"  # used for maintenance tasks, like removing EFS data
+
+
+ProjectShareStatus: TypeAlias = Annotated[
+    ProjectStatus, Field(description="The status of the project")
+]
+ProjectShareLocked: TypeAlias = Annotated[
+    bool, Field(description="True if the project is locked")
+]
+ProjectShareCurrentUserGroupIDs: TypeAlias = Annotated[
+    list[GroupID],
+    Field(
+        description="Current users in the project (if the project is locked, the list contains only the lock owner)"
+    ),
+]
+
+
+class ProjectShareState(BaseModel):
+    status: ProjectShareStatus
+    locked: ProjectShareLocked
+    current_user_groupids: ProjectShareCurrentUserGroupIDs
+
+    @staticmethod
+    def _update_json_schema_extra(schema: JsonDict) -> None:
+        schema.update(
+            {
+                "examples": [
+                    {
+                        "status": ProjectStatus.CLOSED,
+                        "locked": False,
+                        "current_user_groupids": [],
+                    },
+                    {
+                        "status": ProjectStatus.OPENING,
+                        "locked": False,
+                        "current_user_groupids": [
+                            "7",
+                            "15",
+                            "666",
+                        ],
+                    },
+                    {
+                        "status": ProjectStatus.OPENED,
+                        "locked": False,
+                        "current_user_groupids": [
+                            "7",
+                            "15",
+                            "666",
+                        ],
+                    },
+                    {
+                        "status": ProjectStatus.CLONING,
+                        "locked": True,
+                        "current_user_groupids": [
+                            "666",
+                        ],
+                    },
+                ]
+            }
+        )
+
+    model_config = ConfigDict(
+        extra="forbid", json_schema_extra=_update_json_schema_extra
+    )
+
+    @model_validator(mode="after")
+    def check_model_valid(self) -> Self:
+        if (
+            self.status
+            in [
+                ProjectStatus.CLONING,
+                ProjectStatus.EXPORTING,
+                ProjectStatus.MAINTAINING,
+            ]
+            and not self.locked
+        ):
+            msg = f"Project is {self.status=}, but it is not locked"
+            raise ValueError(msg)
+        if self.locked and not self.current_user_groupids:
+            msg = "If the project is locked, the current_users list must contain at least the lock owner"
+            raise ValueError(msg)
+        if self.status is ProjectStatus.CLOSED:
+            if self.locked:
+                msg = "If the project is closed, it cannot be locked"
+                raise ValueError(msg)
+            if self.current_user_groupids:
+                msg = "If the project is closed, the current_users list must be empty"
+                raise ValueError(msg)
+        elif not self.current_user_groupids and (
+            self.status is not ProjectStatus.MAINTAINING
+        ):
+            msg = f"If the project is {self.status=}, the current_users list must not be empty"
+            raise ValueError(msg)
+
+        return self
 
 
 class ProjectLocked(BaseModel):
@@ -144,8 +240,16 @@ class ProjectRunningState(BaseModel):
     model_config = ConfigDict(extra="forbid")
 
 
+ProjectStateShareState: TypeAlias = Annotated[
+    ProjectShareState, Field(description="The project share state")
+]
+ProjectStateRunningState: TypeAlias = Annotated[
+    ProjectRunningState, Field(description="The project running state")
+]
+
+
 class ProjectState(BaseModel):
-    locked: Annotated[ProjectLocked, Field(..., description="The project lock state")]
-    state: ProjectRunningState = Field(..., description="The project running state")
+    share_state: ProjectStateShareState
+    state: ProjectStateRunningState
 
     model_config = ConfigDict(extra="forbid")

packages/models-library/tests/test_projects_state.py

@@ -1,9 +1,13 @@
 import pytest
-from models_library.projects_state import ProjectLocked, ProjectStatus
+from models_library.projects_state import (
+    ProjectLocked,
+    ProjectShareState,
+    ProjectStatus,
+)
 
 
 def test_project_locked_with_missing_owner_raises():
-    with pytest.raises(ValueError):
+    with pytest.raises(ValueError, match=r"1 validation error for ProjectLocked"):
         ProjectLocked(value=True, status=ProjectStatus.OPENED)
     ProjectLocked.model_validate({"value": False, "status": ProjectStatus.OPENED})
 
@@ -22,5 +26,38 @@ def test_project_locked_with_missing_owner_ok_during_maintaining():
     + [(True, ProjectStatus.CLOSED)],
 )
 def test_project_locked_with_allowed_values(lock: bool, status: ProjectStatus):
-    with pytest.raises(ValueError):
+    with pytest.raises(ValueError, match=r"1 validation error for ProjectLocked"):
         ProjectLocked.model_validate({"value": lock, "status": status})
+
+
+@pytest.mark.parametrize(
+    "status,locked,current_users,should_raise",
+    [
+        (ProjectStatus.CLOSED, False, [], False),
+        (ProjectStatus.OPENING, False, [1, 2], False),
+        (ProjectStatus.OPENED, False, [1], False),
+        (ProjectStatus.CLONING, True, [1], False),
+        (ProjectStatus.EXPORTING, True, [1], False),
+        (ProjectStatus.MAINTAINING, True, [1], False),
+        # Invalid: locked but no users
+        (ProjectStatus.CLONING, True, [], True),
+        # Invalid: closed but has users
+        (ProjectStatus.CLOSED, False, [1], True),
+        # Invalid: not closed but no users
+        (ProjectStatus.OPENED, False, [], True),
+    ],
+)
+def test_project_share_state_validations(status, locked, current_users, should_raise):
+    data = {
+        "status": status,
+        "locked": locked,
+        "current_user_groupids": current_users,
+    }
+    if should_raise:
+        with pytest.raises(ValueError, match=r"If the project is "):
+            ProjectShareState.model_validate(data)
+    else:
+        state = ProjectShareState.model_validate(data)
+        assert state.status == status
+        assert state.locked == locked
+        assert state.current_user_groupids == current_users

packages/pytest-simcore/src/pytest_simcore/helpers/playwright.py

@@ -274,8 +274,8 @@ def __call__(self, message: str) -> bool:
             decoded_message = decode_socketio_42_message(message)
             if (
                 (decoded_message.name == _OSparcMessages.PROJECT_STATE_UPDATED.value)
-                and (decoded_message.obj["data"]["locked"]["status"] == "CLOSED")
-                and (decoded_message.obj["data"]["locked"]["value"] is False)
+                and (decoded_message.obj["data"]["shareState"]["status"] == "CLOSED")
+                and (decoded_message.obj["data"]["shareState"]["locked"] is False)
             ):
                 self.logger.info("project successfully closed")
                 return True

packages/pytest-simcore/src/pytest_simcore/helpers/webserver_projects.py

@@ -4,7 +4,6 @@
 
 import json
 import uuid as uuidlib
-from http import HTTPStatus
 from pathlib import Path
 from typing import Any
 
@@ -187,7 +186,7 @@ async def __aexit__(self, *args):
 async def assert_get_same_project(
     client: TestClient,
     project: ProjectDict,
-    expected: HTTPStatus,
+    expected: int,
     api_vtag="/v0",
 ) -> dict:
     # GET /v0/projects/{project_id}

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

@@ -70,7 +70,11 @@ def request_desc(self) -> str:
             "prjOwner": "[email protected]",
             "tags": [],
             "state": {
-                "locked": {"value": False, "status": "CLOSED"},
+                "shareState": {
+                    "status": "CLOSED",
+                    "locked": False,
+                    "currentUserGroupids": [],
+                },
                 "state": {"value": "NOT_STARTED"},
             },
             "dev": None,
@@ -114,7 +118,11 @@ def request_desc(self) -> str:
             "quality": {},
             "tags": [],
             "state": {
-                "locked": {"value": False, "status": "CLOSED"},
+                "shareState": {
+                    "status": "CLOSED",
+                    "locked": False,
+                    "currentUserGroupids": [],
+                },
                 "state": {"value": "NOT_STARTED"},
             },
             "workspace_id": None,
@@ -149,14 +157,10 @@ def request_desc(self) -> str:
             "quality": {},
             "tags": [],
             "state": {
-                "locked": {
-                    "value": True,
-                    "owner": {
-                        "user_id": 1,
-                        "first_name": "crespo",
-                        "last_name": "",
-                    },
+                "shareState": {
                     "status": "OPENED",
+                    "locked": True,
+                    "currentUserGroupids": [1],
                 },
                 "state": {"value": "NOT_STARTED"},
             },
@@ -284,14 +288,10 @@ def request_desc(self) -> str:
             },
             "tags": [],
             "state": {
-                "locked": {
-                    "value": True,
-                    "owner": {
-                        "user_id": 1,
-                        "first_name": "crespo",
-                        "last_name": "",
-                    },
+                "shareState": {
                     "status": "OPENED",
+                    "locked": True,
+                    "currentUserGroupids": [1],
                 },
                 "state": {"value": "NOT_STARTED"},
             },
@@ -547,14 +547,10 @@ def request_desc(self) -> str:
             },
             "tags": [],
             "state": {
-                "locked": {
-                    "value": True,
-                    "owner": {
-                        "user_id": 1,
-                        "first_name": "crespo",
-                        "last_name": "",
-                    },
+                "shareState": {
                     "status": "OPENED",
+                    "locked": True,
+                    "currentUserGroupids": [1],
                 },
                 "state": {"value": "NOT_STARTED"},
             },
@@ -734,7 +730,11 @@ def request_desc(self) -> str:
                 },
                 "tags": [],
                 "state": {
-                    "locked": {"value": False, "status": "CLOSED"},
+                    "shareState": {
+                        "status": "CLOSED",
+                        "locked": False,
+                        "currentUserGroupids": [],
+                    },
                     "state": {"value": "NOT_STARTED"},
                 },
             }
@@ -988,7 +988,11 @@ def request_desc(self) -> str:
             "prjOwner": "[email protected]",
             "tags": [22],
             "state": {
-                "locked": {"value": False, "status": "CLOSED"},
+                "shareState": {
+                    "status": "CLOSED",
+                    "locked": False,
+                    "currentUserGroupids": [],
+                },
                 "state": {"value": "NOT_STARTED"},
             },
         }