fix tests

matusdrobuliak66 · matusdrobuliak66 · commit 503ef0f8868f · 2025-07-30T09:49:57.000+02:00
diff --git a/services/web/server/src/simcore_service_webserver/projects/_project_document_utils.py b/services/web/server/src/simcore_service_webserver/projects/_project_document_utils.py
@@ -0,0 +1,83 @@
+"""Utility functions for project document management.
+
+This module contains common utilities for building and versioning project documents.
+"""
+
+from typing import cast
+
+from aiohttp import web
+from models_library.api_schemas_webserver.projects import ProjectDocument
+from models_library.projects import ProjectID, ProjectTemplateType
+from models_library.projects import ProjectType as ProjectTypeAPI
+from servicelib.redis import (
+    PROJECT_DB_UPDATE_REDIS_LOCK_KEY,
+    exclusive,
+    increment_and_return_project_document_version,
+)
+
+from ..redis import (
+    get_redis_document_manager_client_sdk,
+    get_redis_lock_manager_client_sdk,
+)
+from . import _projects_repository
+
+
+async def build_project_document_and_increment_version(
+    app: web.Application, project_uuid: ProjectID
+) -> tuple[ProjectDocument, int]:
+    """Build project document and increment version with Redis lock protection.
+
+    This function is protected by Redis exclusive lock because:
+    - the project document and its version must be kept in sync
+
+    Args:
+        app: The web application instance
+        project_uuid: UUID of the project
+
+    Returns:
+        Tuple containing the project document and its version number
+    """
+
+    @exclusive(
+        get_redis_lock_manager_client_sdk(app),
+        lock_key=PROJECT_DB_UPDATE_REDIS_LOCK_KEY.format(project_uuid),
+        blocking=True,
+        blocking_timeout=None,  # NOTE: this is a blocking call, a timeout has undefined effects
+    )
+    async def _build_project_document_and_increment_version() -> (
+        tuple[ProjectDocument, int]
+    ):
+        """This function is protected because
+        - the project document and its version must be kept in sync
+        """
+        # Get the full project with workbench for document creation
+        project_with_workbench = await _projects_repository.get_project_with_workbench(
+            app=app, project_uuid=project_uuid
+        )
+        # Create project document
+        project_document = ProjectDocument(
+            uuid=project_with_workbench.uuid,
+            workspace_id=project_with_workbench.workspace_id,
+            name=project_with_workbench.name,
+            description=project_with_workbench.description,
+            thumbnail=project_with_workbench.thumbnail,
+            last_change_date=project_with_workbench.last_change_date,
+            classifiers=project_with_workbench.classifiers,
+            dev=project_with_workbench.dev,
+            quality=project_with_workbench.quality,
+            workbench=project_with_workbench.workbench,
+            ui=project_with_workbench.ui,
+            type=cast(ProjectTypeAPI, project_with_workbench.type),
+            template_type=cast(
+                ProjectTemplateType, project_with_workbench.template_type
+            ),
+        )
+        # Increment document version
+        redis_client_sdk = get_redis_document_manager_client_sdk(app)
+        document_version = await increment_and_return_project_document_version(
+            redis_client=redis_client_sdk, project_uuid=project_uuid
+        )
+
+        return project_document, document_version
+
+    return await _build_project_document_and_increment_version()
diff --git a/services/web/server/src/simcore_service_webserver/projects/_projects_repository_legacy.py b/services/web/server/src/simcore_service_webserver/projects/_projects_repository_legacy.py
@@ -15,7 +15,6 @@
 from aiopg.sa import Engine
 from aiopg.sa.connection import SAConnection
 from aiopg.sa.result import ResultProxy, RowProxy
-from models_library.api_schemas_webserver.projects import ProjectDocument
 from models_library.basic_types import IDStr
 from models_library.folders import FolderQuery, FolderScope
 from models_library.groups import GroupID
@@ -26,7 +25,6 @@
     ProjectListAtDB,
     ProjectTemplateType,
 )
-from models_library.projects import ProjectType as ProjectTypeAPI
 from models_library.projects_comments import CommentID, ProjectsCommentsDB
 from models_library.projects_nodes import Node
 from models_library.projects_nodes_io import NodeID, NodeIDStr
@@ -44,11 +42,6 @@
 from pydantic.types import PositiveInt
 from servicelib.aiohttp.application_keys import APP_AIOPG_ENGINE_KEY
 from servicelib.logging_utils import get_log_record_extra, log_context
-from servicelib.redis import (
-    PROJECT_DB_UPDATE_REDIS_LOCK_KEY,
-    exclusive,
-    increment_and_return_project_document_version,
-)
 from simcore_postgres_database.aiopg_errors import UniqueViolation
 from simcore_postgres_database.models.groups import user_to_groups
 from simcore_postgres_database.models.project_to_groups import project_to_groups
@@ -82,12 +75,7 @@
 from tenacity.asyncio import AsyncRetrying
 from tenacity.retry import retry_if_exception_type
 
-from ..redis import (
-    get_redis_document_manager_client_sdk,
-    get_redis_lock_manager_client_sdk,
-)
 from ..utils import now_str
-from . import _projects_repository
 from ._comments_repository import (
     create_project_comment,
     delete_project_comment,
@@ -96,6 +84,7 @@
     total_project_comments,
     update_project_comment,
 )
+from ._project_document_utils import build_project_document_and_increment_version
 from ._projects_repository import PROJECT_DB_COLS
 from ._projects_repository_legacy_utils import (
     ANY_USER_ID_SENTINEL,
@@ -967,54 +956,10 @@ async def _update_project_workbench_with_lock_and_notify(
             allow_workbench_changes=allow_workbench_changes,
         )
 
-        @exclusive(
-            get_redis_lock_manager_client_sdk(self._app),
-            lock_key=PROJECT_DB_UPDATE_REDIS_LOCK_KEY.format(project_uuid),
-            blocking=True,
-            blocking_timeout=None,  # NOTE: this is a blocking call, a timeout has undefined effects
-        )
-        async def _build_project_document_and_increment_version() -> (
-            tuple[ProjectDocument, int]
-        ):
-            """This function is protected because
-            - the project document and its version must be kept in sync
-            """
-            # Get the full project with workbench for document creation
-            project_with_workbench = (
-                await _projects_repository.get_project_with_workbench(
-                    app=self._app, project_uuid=project_uuid
-                )
-            )
-            # Create project document
-            project_document = ProjectDocument(
-                uuid=project_with_workbench.uuid,
-                workspace_id=project_with_workbench.workspace_id,
-                name=project_with_workbench.name,
-                description=project_with_workbench.description,
-                thumbnail=project_with_workbench.thumbnail,
-                last_change_date=project_with_workbench.last_change_date,
-                classifiers=project_with_workbench.classifiers,
-                dev=project_with_workbench.dev,
-                quality=project_with_workbench.quality,
-                workbench=project_with_workbench.workbench,
-                ui=project_with_workbench.ui,
-                type=cast(ProjectTypeAPI, project_with_workbench.type),
-                template_type=cast(
-                    ProjectTemplateType, project_with_workbench.template_type
-                ),
-            )
-            # Increment document version
-            redis_client_sdk = get_redis_document_manager_client_sdk(self._app)
-            document_version = await increment_and_return_project_document_version(
-                redis_client=redis_client_sdk, project_uuid=project_uuid
-            )
-
-            return project_document, document_version
-
         (
             project_document,
             document_version,
-        ) = await _build_project_document_and_increment_version()
+        ) = await build_project_document_and_increment_version(self._app, project_uuid)
 
         await notify_project_document_updated(
             app=self._app,
diff --git a/services/web/server/src/simcore_service_webserver/projects/_projects_service.py b/services/web/server/src/simcore_service_webserver/projects/_projects_service.py
@@ -30,7 +30,6 @@
     DynamicServiceStop,
 )
 from models_library.api_schemas_webserver.projects import (
-    ProjectDocument,
     ProjectGet,
     ProjectPatch,
 )
@@ -39,8 +38,7 @@
 from models_library.errors import ErrorDict
 from models_library.groups import GroupID
 from models_library.products import ProductName
-from models_library.projects import Project, ProjectID, ProjectTemplateType
-from models_library.projects import ProjectType as ProjectTypeAPI
+from models_library.projects import Project, ProjectID
 from models_library.projects_access import Owner
 from models_library.projects_nodes import Node, NodeState, PartialNode
 from models_library.projects_nodes_io import NodeID, NodeIDStr, PortLink
@@ -85,10 +83,8 @@
     ServiceWasNotFoundError,
 )
 from servicelib.redis import (
-    PROJECT_DB_UPDATE_REDIS_LOCK_KEY,
     exclusive,
     get_project_locked_state,
-    increment_and_return_project_document_version,
     is_project_locked,
     with_project_locked,
 )
@@ -107,10 +103,7 @@
 from ..dynamic_scheduler import api as dynamic_scheduler_service
 from ..products import products_web
 from ..rabbitmq import get_rabbitmq_rpc_client
-from ..redis import (
-    get_redis_document_manager_client_sdk,
-    get_redis_lock_manager_client_sdk,
-)
+from ..redis import get_redis_lock_manager_client_sdk
 from ..resource_manager.models import UserSession
 from ..resource_manager.user_sessions import (
     PROJECT_ID_KEY,
@@ -146,6 +139,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 ._projects_repository_legacy import APP_PROJECT_DBAPI, ProjectDBAPI
 from ._projects_repository_legacy_utils import PermissionStr
 from ._socketio_service import notify_project_document_updated
@@ -209,46 +203,8 @@ async def patch_project_and_notify_users(
         new_partial_project_data=patch_project_data,
     )
 
-    @exclusive(
-        get_redis_lock_manager_client_sdk(app),
-        lock_key=PROJECT_DB_UPDATE_REDIS_LOCK_KEY.format(project_uuid),
-        blocking=True,
-        blocking_timeout=None,  # NOTE: this is a blocking call, a timeout has undefined effects
-    )
-    async def _build_project_document_and_increment_version() -> (
-        tuple[ProjectDocument, int]
-    ):
-        """This function is protected because
-        - the project document and its version must be kept in sync
-        """
-        project_with_workbench = await _projects_repository.get_project_with_workbench(
-            app=app, project_uuid=project_uuid
-        )
-        project_document = ProjectDocument(
-            uuid=project_with_workbench.uuid,
-            workspace_id=project_with_workbench.workspace_id,
-            name=project_with_workbench.name,
-            description=project_with_workbench.description,
-            thumbnail=project_with_workbench.thumbnail,
-            last_change_date=project_with_workbench.last_change_date,
-            classifiers=project_with_workbench.classifiers,
-            dev=project_with_workbench.dev,
-            quality=project_with_workbench.quality,
-            workbench=project_with_workbench.workbench,
-            ui=project_with_workbench.ui,
-            type=cast(ProjectTypeAPI, project_with_workbench.type),
-            template_type=cast(
-                ProjectTemplateType, project_with_workbench.template_type
-            ),
-        )
-        redis_client_sdk = get_redis_document_manager_client_sdk(app)
-        document_version = await increment_and_return_project_document_version(
-            redis_client=redis_client_sdk, project_uuid=project_uuid
-        )
-        return project_document, document_version
-
     project_document, document_version = (
-        await _build_project_document_and_increment_version()
+        await build_project_document_and_increment_version(app, project_uuid)
     )
     await notify_project_document_updated(
         app=app,
