fixed examples

Author: sanderegg

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

@@ -75,42 +75,40 @@
 UnitStr: TypeAlias = Annotated[str, StringConstraints(strip_whitespace=True)]
 
 
-class NodeLockReason(StrAutoEnum):
+class NodeShareStatus(StrAutoEnum):
     OPENING = auto()
     OPENED = auto()
     CLOSING = auto()
 
 
-class NodeLockState(BaseModel):
-    is_locked: Annotated[
+class NodeShareState(BaseModel):
+    locked: Annotated[
         bool,
         Field(
             description="True if the node is locked, False otherwise",
         ),
     ]
 
-    locked_by: Annotated[
-        GroupID | None,
-        Field(description="Group that owns locked the node, None if not locked"),
+    current_user_groupids: Annotated[
+        list[GroupID] | None,
+        Field(
+            description="Group(s) that currently have access to the node (or locked it)"
+        ),
     ] = None
 
-    locked_reason: Annotated[
-        NodeLockReason | None,
+    status: Annotated[
+        NodeShareStatus | None,
         Field(
             description="Reason why the node is locked, None if not locked",
         ),
     ] = None
 
     @model_validator(mode="after")
-    def _validate_lock_state(self) -> "NodeLockState":
-        if self.is_locked and (self.locked_by is None or self.locked_reason is None):
-            msg = "If the node is locked, both 'locked_by' and 'locked_reason' must be set"
-            raise ValueError(msg)
-        if not self.is_locked and (
-            self.locked_by is not None or self.locked_reason is not None
-        ):
-            msg = "If the node is not locked, both 'locked_by' and 'locked_reason' must be None"
+    def _validate_lock_state(self) -> "NodeShareState":
+        if self.locked and (self.current_user_groupids is None or self.status is None):
+            msg = "If the node is locked, both 'current_user_groupids' and 'status' must be set"
             raise ValueError(msg)
+
         return self
 
     @staticmethod
@@ -119,12 +117,17 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
             {
                 "examples": [
                     {
-                        "is_locked": False,
+                        "locked": False,
                     },
                     {
-                        "is_locked": True,
-                        "locked_by": 666,
-                        "locked_reason": "OPENING",
+                        "locked": True,
+                        "current_user_groupids": [666],
+                        "status": "OPENING",
+                    },
+                    {
+                        "locked": False,
+                        "current_user_groupids": [666, 4563],
+                        "status": "OPENED",
                     },
                 ]
             }
@@ -168,9 +171,9 @@ class NodeState(BaseModel):
         ),
     ] = 0
 
-    lock_state: Annotated[NodeLockState, Field(description="the node's lock state")] = (
-        NodeLockState(is_locked=False, locked_by=None, locked_reason=None)
-    )
+    lock_state: Annotated[
+        NodeShareState, Field(description="the node's lock state")
+    ] = NodeShareState(locked=False, current_user_groupids=None, status=None)
 
     model_config = ConfigDict(
         extra="forbid",

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

@@ -48,8 +48,8 @@
 from models_library.projects_access import Owner
 from models_library.projects_nodes import (
     Node,
-    NodeLockReason,
-    NodeLockState,
+    NodeShareState,
+    NodeShareStatus,
     NodeState,
     PartialNode,
 )
@@ -1375,9 +1375,9 @@ async def is_node_id_present_in_any_project_workbench(
     return await db.node_id_exists(node_id)
 
 
-async def _get_node_lock_state(
+async def _get_node_share_state(
     app: web.Application, *, user_id: UserID, project_uuid: ProjectID, node_id: NodeID
-) -> NodeLockState:
+) -> NodeShareState:
     node = await _projects_nodes_repository.get(
         app, project_id=project_uuid, node_id=node_id
     )
@@ -1390,28 +1390,32 @@ async def _get_node_lock_state(
 
         if isinstance(service, DynamicServiceGet | NodeGet):
             # service is running
-            return NodeLockState(
-                is_locked=True,
-                locked_by=await users_service.get_user_primary_group_id(
-                    app, TypeAdapter(UserID).validate_python(service.user_id)
-                ),
-                locked_reason=NodeLockReason.OPENED,
+            return NodeShareState(
+                locked=True,
+                current_user_groupids=[
+                    await users_service.get_user_primary_group_id(
+                        app, TypeAdapter(UserID).validate_python(service.user_id)
+                    )
+                ],
+                status=NodeShareStatus.OPENED,
             )
         if isinstance(service, NodeGetUnknown):
             # service state is unknown
             # we should raise an exception here
             msg = "Node state is unknown"
             raise RuntimeError(msg)
-        return NodeLockState(is_locked=False)
+        return NodeShareState(locked=False)
 
     # if the service is computational and no pipeline is running it is not locked
     if await director_v2_service.is_pipeline_running(app, user_id, project_uuid):
-        return NodeLockState(
-            is_locked=True,
-            locked_by=await users_service.get_user_primary_group_id(app, user_id),
-            locked_reason=NodeLockReason.OPENED,
+        return NodeShareState(
+            locked=True,
+            current_user_groupids=[
+                await users_service.get_user_primary_group_id(app, user_id)
+            ],
+            status=NodeShareStatus.OPENED,
         )
-    return NodeLockState(is_locked=False)
+    return NodeShareState(locked=False)
 
 
 async def _safe_retrieve(
@@ -1822,7 +1826,7 @@ async def add_project_states_for_user(
     for node_uuid, node in project["workbench"].items():
         assert isinstance(node, dict)  # nosec
 
-        node_lock_state = await _get_node_lock_state(
+        node_lock_state = await _get_node_share_state(
             app,
             user_id=user_id,
             project_uuid=project["uuid"],