review @pcrespov

Author: matusdrobuliak66

services/web/server/src/simcore_service_webserver/folders/_workspaces_repository.py

@@ -8,6 +8,7 @@
 from simcore_postgres_database.utils_repos import transaction_context
 
 from ..db.plugin import get_asyncpg_engine
+from ..models import ClientSessionID
 from ..projects import _folders_repository as projects_folders_repository
 from ..projects import _groups_repository as projects_groups_repository
 from ..projects._access_rights_service import check_user_project_permission
@@ -26,7 +27,7 @@ async def move_folder_into_workspace(
     folder_id: FolderID,
     workspace_id: WorkspaceID | None,
     product_name: ProductName,
-    client_session_id: str | None = None,
+    client_session_id: ClientSessionID | None = None,
 ) -> None:
     # 1. User needs to have delete permission on source folder
     folder_db = await _folders_repository.get(

services/web/server/src/simcore_service_webserver/models.py

@@ -3,7 +3,7 @@
 from models_library.products import ProductName
 from models_library.rest_base import RequestParameters
 from models_library.users import UserID
-from pydantic import ConfigDict, Field
+from pydantic import ConfigDict, Field, StringConstraints
 from pydantic_extra_types.phone_numbers import PhoneNumberValidator
 from servicelib.request_keys import RQT_USERID_KEY
 from servicelib.rest_constants import X_CLIENT_SESSION_ID_HEADER
@@ -17,6 +17,18 @@
 ]
 
 
+ClientSessionID: TypeAlias = Annotated[
+    str,
+    StringConstraints(
+        strip_whitespace=True,
+        min_length=36,
+        max_length=36,
+        pattern=r"^[0-9a-fA-F\-]{36}$",  # UUID format
+        strict=True,
+    ),
+]
+
+
 class AuthenticatedRequestContext(RequestParameters):
     """Fields expected in the request context for authenticated endpoints"""
 
@@ -31,10 +43,10 @@ class AuthenticatedRequestContext(RequestParameters):
 class ClientSessionHeaderParams(RequestParameters):
     """Header parameters for client session tracking in collaborative features."""
 
-    client_session_id: str | None = Field(
+    client_session_id: ClientSessionID | None = Field(
         default=None,
         alias=X_CLIENT_SESSION_ID_HEADER,
-        description="Client session identifier for collaborative features",
+        description="Client session identifier for collaborative features (UUID string)",
     )
 
     model_config = ConfigDict(

services/web/server/src/simcore_service_webserver/projects/_project_document_utils.py renamed to services/web/server/src/simcore_service_webserver/projects/_project_document_service.py

@@ -25,7 +25,7 @@
 from . import _projects_repository
 
 
-async def build_project_document_and_increment_version(
+async def create_project_document_and_increment_version(
     app: web.Application, project_uuid: ProjectID
 ) -> tuple[ProjectDocument, ProjectDocumentVersion]:
     """Build project document and increment version with Redis lock protection.
@@ -47,7 +47,7 @@ async def build_project_document_and_increment_version(
         blocking=True,
         blocking_timeout=None,  # NOTE: this is a blocking call, a timeout has undefined effects
     )
-    async def _build_project_document_and_increment_version() -> (
+    async def _create_project_document_and_increment_version() -> (
         tuple[ProjectDocument, int]
     ):
         """This function is protected because
@@ -83,4 +83,4 @@ async def _build_project_document_and_increment_version() -> (
 
         return project_document, document_version
 
-    return await _build_project_document_and_increment_version()
+    return await _create_project_document_and_increment_version()

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

@@ -75,6 +75,7 @@
 from tenacity.asyncio import AsyncRetrying
 from tenacity.retry import retry_if_exception_type
 
+from ..models import ClientSessionID
 from ..utils import now_str
 from ._comments_repository import (
     create_project_comment,
@@ -84,7 +85,7 @@
     total_project_comments,
     update_project_comment,
 )
-from ._project_document_utils import build_project_document_and_increment_version
+from ._project_document_service import create_project_document_and_increment_version
 from ._projects_repository import PROJECT_DB_COLS
 from ._projects_repository_legacy_utils import (
     ANY_USER_ID_SENTINEL,
@@ -870,7 +871,7 @@ async def update_project_node_data(
         node_id: NodeID,
         product_name: str | None,
         new_node_data: dict[str, Any],
-        client_session_id: str | None,
+        client_session_id: ClientSessionID | None,
     ) -> tuple[ProjectDict, dict[NodeIDStr, Any]]:
         with log_context(
             _logger,
@@ -897,7 +898,7 @@ async def update_project_multiple_node_data(
         project_uuid: ProjectID,
         product_name: str | None,
         partial_workbench_data: dict[NodeIDStr, dict[str, Any]],
-        client_session_id: str | None,
+        client_session_id: ClientSessionID | None,
     ) -> tuple[ProjectDict, dict[NodeIDStr, Any]]:
         """
         Raises:
@@ -926,7 +927,7 @@ async def _update_project_workbench_with_lock_and_notify(
         project_uuid: ProjectID,
         product_name: str | None = None,
         allow_workbench_changes: bool,
-        client_session_id: str | None,
+        client_session_id: ClientSessionID | None,
     ) -> tuple[ProjectDict, dict[NodeIDStr, Any]]:
         """
         Updates project workbench with Redis lock and user notification.
@@ -959,7 +960,7 @@ async def _update_project_workbench_with_lock_and_notify(
         (
             project_document,
             document_version,
-        ) = await build_project_document_and_increment_version(self._app, project_uuid)
+        ) = await create_project_document_and_increment_version(self._app, project_uuid)
 
         await notify_project_document_updated(
             app=self._app,
@@ -1049,7 +1050,7 @@ async def add_project_node(
         node: ProjectNodeCreate,
         old_struct_node: Node,
         product_name: str,
-        client_session_id: str | None,
+        client_session_id: ClientSessionID | None,
     ) -> None:
         # NOTE: permission check is done currently in update_project_workbench!
         partial_workbench_data: dict[NodeIDStr, Any] = {
@@ -1075,7 +1076,7 @@ async def remove_project_node(
         user_id: UserID,
         project_id: ProjectID,
         node_id: NodeID,
-        client_session_id: str | None,
+        client_session_id: ClientSessionID | None,
     ) -> None:
         # NOTE: permission check is done currently in update_project_workbench!
         partial_workbench_data: dict[NodeIDStr, Any] = {

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

@@ -101,6 +101,7 @@
 from ..catalog import catalog_service
 from ..director_v2 import director_v2_service
 from ..dynamic_scheduler import api as dynamic_scheduler_service
+from ..models import ClientSessionID
 from ..products import products_web
 from ..rabbitmq import get_rabbitmq_rpc_client
 from ..redis import get_redis_lock_manager_client_sdk
@@ -139,7 +140,7 @@
     has_user_project_access_rights,
 )
 from ._nodes_utils import set_reservation_same_as_limit, validate_new_service_resources
-from ._project_document_utils import build_project_document_and_increment_version
+from ._project_document_service import create_project_document_and_increment_version
 from ._projects_repository_legacy import APP_PROJECT_DBAPI, ProjectDBAPI
 from ._projects_repository_legacy_utils import PermissionStr
 from ._socketio_service import notify_project_document_updated
@@ -174,7 +175,7 @@ async def patch_project_and_notify_users(
     project_uuid: ProjectID,
     patch_project_data: dict[str, Any],
     user_primary_gid: GroupID,
-    client_session_id: str | None,
+    client_session_id: ClientSessionID | None,
 ) -> None:
     """
     Patches a project and notifies users involved in the project with version control.
@@ -204,7 +205,7 @@ async def patch_project_and_notify_users(
     )
 
     project_document, document_version = (
-        await build_project_document_and_increment_version(app, project_uuid)
+        await create_project_document_and_increment_version(app, project_uuid)
     )
     await notify_project_document_updated(
         app=app,
@@ -357,7 +358,7 @@ async def patch_project_for_user(
     project_uuid: ProjectID,
     project_patch: ProjectPatch | ProjectPatchInternalExtended,
     product_name: ProductName,
-    client_session_id: str | None,
+    client_session_id: ClientSessionID | None,
 ):
     # client_session_id (str | None): The session ID of the frontend client making the request.
     # This is used to distinguish between multiple sessions a user may have open.
@@ -911,7 +912,7 @@ async def add_project_node(
     service_key: ServiceKey,
     service_version: ServiceVersion,
     service_id: str | None,
-    client_session_id: str | None,
+    client_session_id: ClientSessionID | None,
 ) -> NodeID:
     _logger.debug(
         "starting node %s:%s in project %s for user %s",
@@ -1048,7 +1049,7 @@ async def delete_project_node(
     node_uuid: NodeIDStr,
     product_name: ProductName,
     product_api_base_url: str,
-    client_session_id: str | None,
+    client_session_id: ClientSessionID | None,
 ) -> None:
     _logger.debug(
         "deleting node %s in project %s for user %s", node_uuid, project_uuid, user_id
@@ -1119,7 +1120,7 @@ async def update_project_node_state(
     project_id: ProjectID,
     node_id: NodeID,
     new_state: str,
-    client_session_id: str | None,
+    client_session_id: ClientSessionID | None,
 ) -> dict:
     _logger.debug(
         "updating node %s current state in project %s for user %s",
@@ -1176,7 +1177,7 @@ async def patch_project_node(
     project_id: ProjectID,
     node_id: NodeID,
     partial_node: PartialNode,
-    client_session_id: str | None,
+    client_session_id: ClientSessionID | None,
 ) -> None:
     _node_patch_exclude_unset: dict[str, Any] = partial_node.model_dump(
         mode="json", exclude_unset=True, by_alias=True
@@ -1264,7 +1265,7 @@ async def update_project_node_outputs(
     node_id: NodeID,
     new_outputs: dict | None,
     new_run_hash: str | None,
-    client_session_id: str | None,
+    client_session_id: ClientSessionID | None,
 ) -> tuple[dict, list[str]]:
     """
     Updates outputs of a given node in a project with 'data'
@@ -1453,7 +1454,7 @@ async def _leave_project_room(
     *,
     app: web.Application,
     user_id: UserID,
-    client_session_id: str,
+    client_session_id: ClientSessionID,
     project_uuid: ProjectID,
     user_session,
 ) -> None:
@@ -1490,7 +1491,7 @@ async def _notification_cb() -> None:
 async def try_open_project_for_user(
     user_id: UserID,
     project_uuid: ProjectID,
-    client_session_id: str,
+    client_session_id: ClientSessionID,
     app: web.Application,
     *,
     max_number_of_opened_projects_per_user: int | None,
@@ -1596,7 +1597,7 @@ async def _open_project() -> bool:
 async def close_project_for_user(
     user_id: UserID,
     project_uuid: ProjectID,
-    client_session_id: str,
+    client_session_id: ClientSessionID,
     app: web.Application,
     simcore_user_agent: str,
     *,

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

@@ -8,6 +8,7 @@
 from pydantic import AliasGenerator, BaseModel, ConfigDict
 from pydantic.alias_generators import to_camel
 
+from ..models import ClientSessionID
 from ..socketio.messages import send_message_to_project_room
 
 SOCKET_IO_PROJECT_DOCUMENT_UPDATED_EVENT: Final[str] = "projectDocument:updated"
@@ -26,7 +27,7 @@ class BaseEvent(BaseModel):
 class ProjectDocumentEvent(BaseEvent):
     project_id: ProjectID
     user_primary_gid: GroupID
-    client_session_id: str | None
+    client_session_id: ClientSessionID | None
     version: int
     document: ProjectDocument
 
@@ -36,7 +37,7 @@ async def notify_project_document_updated(
     *,
     project_id: ProjectID,
     user_primary_gid: GroupID,
-    client_session_id: str | None,
+    client_session_id: ClientSessionID | None,
     version: int,
     document: ProjectDocument,
 ) -> None:

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

@@ -8,6 +8,7 @@
 from simcore_postgres_database.utils_repos import transaction_context
 
 from ..db.plugin import get_asyncpg_engine
+from ..models import ClientSessionID
 from ..users import users_service
 from ..workspaces.api import check_user_workspace_access
 from . import _folders_repository, _groups_repository, _projects_service
@@ -24,7 +25,7 @@ async def move_project_into_workspace(
     project_id: ProjectID,
     workspace_id: WorkspaceID | None,
     product_name: ProductName,
-    client_session_id: str | None = None,
+    client_session_id: ClientSessionID | None = None,
 ) -> None:
     # 1. User needs to have delete permission on project
     project_access_rights = await get_user_project_access_rights(

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

@@ -9,6 +9,7 @@
 from servicelib.logging_utils import log_decorator
 from servicelib.utils import logged_gather
 
+from ..models import ClientSessionID
 from . import _projects_service
 
 log = logging.getLogger(__name__)
@@ -38,7 +39,7 @@ async def update_node_outputs(
     outputs: dict,
     run_hash: str | None,
     node_errors: list[ErrorDict] | None,
-    client_session_id: str | None,
+    client_session_id: ClientSessionID | None,
     *,
     ui_changed_keys: set[str] | None,
 ) -> None: