review @sanderegg @pcrespov

Author: matusdrobuliak66

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

@@ -2,11 +2,14 @@
 
 from aiohttp import web
 from servicelib.aiohttp import status
-from servicelib.aiohttp.requests_validation import parse_request_path_parameters_as
-from servicelib.rest_constants import X_CLIENT_SESSION_ID_HEADER
+from servicelib.aiohttp.requests_validation import (
+    parse_request_headers_as,
+    parse_request_path_parameters_as,
+)
 
 from .._meta import api_version_prefix as VTAG
 from ..login.decorators import login_required
+from ..models import ClientSessionHeaderParams
 from ..security.decorators import permission_required
 from . import _workspaces_repository
 from ._common.exceptions_handlers import handle_plugin_requests_exceptions
@@ -28,15 +31,14 @@
 async def move_folder_to_workspace(request: web.Request):
     req_ctx = FoldersRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(FolderWorkspacesPathParams, request)
-
-    client_session_id: str | None = request.headers.get(X_CLIENT_SESSION_ID_HEADER)
+    header_params = parse_request_headers_as(ClientSessionHeaderParams, request)
 
     await _workspaces_repository.move_folder_into_workspace(
         app=request.app,
         user_id=req_ctx.user_id,
         folder_id=path_params.folder_id,
         workspace_id=path_params.workspace_id,
         product_name=req_ctx.product_name,
-        client_session_id=client_session_id,
+        client_session_id=header_params.client_session_id,
     )
     return web.json_response(status=status.HTTP_204_NO_CONTENT)

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

@@ -6,6 +6,7 @@
 from pydantic import ConfigDict, Field
 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
 
 from .constants import RQ_PRODUCT_KEY
 
@@ -25,3 +26,18 @@ class AuthenticatedRequestContext(RequestParameters):
     model_config = ConfigDict(
         frozen=True  # prevents modifications after middlewares creates this model
     )
+
+
+class ClientSessionHeaderParams(RequestParameters):
+    """Header parameters for client session tracking in collaborative features."""
+
+    client_session_id: str | None = Field(
+        default=None,
+        alias=X_CLIENT_SESSION_ID_HEADER,
+        description="Client session identifier for collaborative features",
+    )
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        extra="forbid",
+    )

services/web/server/src/simcore_service_webserver/projects/_controller/nodes_rest.py

@@ -35,6 +35,7 @@
 from servicelib.aiohttp.long_running_tasks.server import start_long_running_task
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
+    parse_request_headers_as,
     parse_request_path_parameters_as,
     parse_request_query_parameters_as,
 )
@@ -50,7 +51,6 @@
     ServiceWaitingForManualInterventionError,
     ServiceWasNotFoundError,
 )
-from servicelib.rest_constants import X_CLIENT_SESSION_ID_HEADER
 from servicelib.services_utils import get_status_as_dict
 from simcore_postgres_database.models.users import UserRole
 
@@ -60,6 +60,7 @@
 from ...groups.api import get_group_from_gid, list_all_user_groups_ids
 from ...groups.exceptions import GroupNotFoundError
 from ...login.decorators import login_required
+from ...models import ClientSessionHeaderParams
 from ...security.decorators import permission_required
 from ...users import users_service
 from ...utils_aiohttp import envelope_json_response, get_api_base_url
@@ -97,8 +98,7 @@ async def create_node(request: web.Request) -> web.Response:
     req_ctx = AuthenticatedRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(ProjectPathParams, request)
     body = await parse_request_body_as(NodeCreate, request)
-
-    client_session_id = request.headers.get(X_CLIENT_SESSION_ID_HEADER)
+    header_params = parse_request_headers_as(ClientSessionHeaderParams, request)
 
     if await _projects_service.is_service_deprecated(
         request.app,
@@ -127,7 +127,7 @@ async def create_node(request: web.Request) -> web.Response:
             body.service_key,
             body.service_version,
             body.service_id,
-            client_session_id=client_session_id,
+            client_session_id=header_params.client_session_id,
         )
     }
     assert NodeCreated.model_validate(data) is not None  # nosec
@@ -182,8 +182,7 @@ async def patch_project_node(request: web.Request) -> web.Response:
     req_ctx = AuthenticatedRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(NodePathParams, request)
     node_patch = await parse_request_body_as(NodePatch, request)
-
-    client_session_id = request.headers.get(X_CLIENT_SESSION_ID_HEADER)
+    header_params = parse_request_headers_as(ClientSessionHeaderParams, request)
 
     await _projects_service.patch_project_node(
         request.app,
@@ -193,7 +192,7 @@ async def patch_project_node(request: web.Request) -> web.Response:
         project_id=path_params.project_id,
         node_id=path_params.node_id,
         partial_node=node_patch.to_domain_model(),
-        client_session_id=client_session_id,
+        client_session_id=header_params.client_session_id,
     )
 
     return web.json_response(status=status.HTTP_204_NO_CONTENT)
@@ -206,8 +205,7 @@ async def patch_project_node(request: web.Request) -> web.Response:
 async def delete_node(request: web.Request) -> web.Response:
     req_ctx = AuthenticatedRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(NodePathParams, request)
-
-    client_session_id = request.headers.get(X_CLIENT_SESSION_ID_HEADER)
+    header_params = parse_request_headers_as(ClientSessionHeaderParams, request)
 
     # ensure the project exists
     await _projects_service.get_project_for_user(
@@ -222,7 +220,7 @@ async def delete_node(request: web.Request) -> web.Response:
         NodeIDStr(path_params.node_id),
         req_ctx.product_name,
         product_api_base_url=get_api_base_url(request),
-        client_session_id=client_session_id,
+        client_session_id=header_params.client_session_id,
     )
 
     return web.json_response(status=status.HTTP_204_NO_CONTENT)
@@ -259,8 +257,7 @@ async def update_node_outputs(request: web.Request) -> web.Response:
     req_ctx = AuthenticatedRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(NodePathParams, request)
     node_outputs = await parse_request_body_as(NodeOutputs, request)
-
-    client_session_id = request.headers.get(X_CLIENT_SESSION_ID_HEADER)
+    header_params = parse_request_headers_as(ClientSessionHeaderParams, request)
 
     ui_changed_keys = set()
     ui_changed_keys.add(f"{path_params.node_id}")
@@ -273,7 +270,7 @@ async def update_node_outputs(request: web.Request) -> web.Response:
         run_hash=None,
         node_errors=None,
         ui_changed_keys=ui_changed_keys,
-        client_session_id=client_session_id,
+        client_session_id=header_params.client_session_id,
     )
     return web.json_response(status=status.HTTP_204_NO_CONTENT)
 

services/web/server/src/simcore_service_webserver/projects/_controller/ports_rest.py

@@ -17,12 +17,13 @@
 from pydantic import BaseModel, Field, TypeAdapter
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
+    parse_request_headers_as,
     parse_request_path_parameters_as,
 )
-from servicelib.rest_constants import X_CLIENT_SESSION_ID_HEADER
 
 from ..._meta import API_VTAG as VTAG
 from ...login.decorators import login_required
+from ...models import ClientSessionHeaderParams
 from ...security.decorators import permission_required
 from ...utils_aiohttp import envelope_json_response
 from .. import _ports_service, _projects_service
@@ -89,8 +90,7 @@ async def update_project_inputs(request: web.Request) -> web.Response:
     req_ctx = AuthenticatedRequestContext.model_validate(request)
     path_params = parse_request_path_parameters_as(ProjectPathParams, request)
     inputs_updates = await parse_request_body_as(list[ProjectInputUpdate], request)
-
-    client_session_id: str | None = request.headers.get(X_CLIENT_SESSION_ID_HEADER)
+    header_params = parse_request_headers_as(ClientSessionHeaderParams, request)
 
     assert request.app  # nosec
 
@@ -126,7 +126,7 @@ async def update_project_inputs(request: web.Request) -> web.Response:
         project_uuid=path_params.project_id,
         product_name=req_ctx.product_name,
         partial_workbench_data=jsonable_encoder(partial_workbench_data),
-        client_session_id=client_session_id,
+        client_session_id=header_params.client_session_id,
     )
 
     workbench = TypeAdapter(dict[NodeID, Node]).validate_python(

services/web/server/src/simcore_service_webserver/projects/_controller/projects_rest.py

@@ -25,10 +25,10 @@
     X_SIMCORE_USER_AGENT,
 )
 from servicelib.redis import get_project_locked_state
-from servicelib.rest_constants import X_CLIENT_SESSION_ID_HEADER
 
 from ..._meta import API_VTAG as VTAG
 from ...login.decorators import login_required
+from ...models import ClientSessionHeaderParams
 from ...redis import get_redis_lock_manager_client_sdk
 from ...resource_manager.user_sessions import PROJECT_ID_KEY, managed_resource
 from ...security import security_web
@@ -314,15 +314,15 @@ async def patch_project(request: web.Request):
     path_params = parse_request_path_parameters_as(ProjectPathParams, request)
     project_patch = await parse_request_body_as(ProjectPatch, request)
 
-    client_session_id: str | None = request.headers.get(X_CLIENT_SESSION_ID_HEADER)
+    header_params = parse_request_headers_as(ClientSessionHeaderParams, request)
 
     await _projects_service.patch_project_for_user(
         request.app,
         user_id=req_ctx.user_id,
         project_uuid=path_params.project_id,
         project_patch=project_patch,
         product_name=req_ctx.product_name,
-        client_session_id=client_session_id,
+        client_session_id=header_params.client_session_id,
     )
 
     return web.json_response(status=status.HTTP_204_NO_CONTENT)

services/web/server/src/simcore_service_webserver/projects/_controller/workspaces_rest.py

@@ -7,11 +7,14 @@
 from models_library.workspaces import WorkspaceID
 from pydantic import BaseModel, BeforeValidator, ConfigDict, Field
 from servicelib.aiohttp import status
-from servicelib.aiohttp.requests_validation import parse_request_path_parameters_as
-from servicelib.rest_constants import X_CLIENT_SESSION_ID_HEADER
+from servicelib.aiohttp.requests_validation import (
+    parse_request_headers_as,
+    parse_request_path_parameters_as,
+)
 
 from ..._meta import api_version_prefix as VTAG
 from ...login.decorators import login_required
+from ...models import ClientSessionHeaderParams
 from ...security.decorators import permission_required
 from .. import _workspaces_service
 from ._rest_exceptions import handle_plugin_requests_exceptions
@@ -44,15 +47,14 @@ async def move_project_to_workspace(request: web.Request):
     path_params = parse_request_path_parameters_as(
         _ProjectWorkspacesPathParams, request
     )
-
-    client_session_id: str | None = request.headers.get(X_CLIENT_SESSION_ID_HEADER)
+    header_params = parse_request_headers_as(ClientSessionHeaderParams, request)
 
     await _workspaces_service.move_project_into_workspace(
         app=request.app,
         user_id=req_ctx.user_id,
         project_id=path_params.project_id,
         workspace_id=path_params.workspace_id,
         product_name=req_ctx.product_name,
-        client_session_id=client_session_id,
+        client_session_id=header_params.client_session_id,
     )
     return web.json_response(status=status.HTTP_204_NO_CONTENT)