✨ Is1647/collaboration feature - 1. iteration (OPS ⚠️) (#8140)

Co-authored-by: Sylvain <[email protected]>

Author: matusdrobuliak66

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

@@ -283,6 +283,25 @@ def to_domain_model(self) -> dict[str, Any]:
         return self.model_dump(exclude_unset=True, by_alias=False)
 
 
+class ProjectDocument(OutputSchema):
+    uuid: ProjectID
+    workspace_id: WorkspaceID | None
+    name: str
+    description: str
+    thumbnail: HttpUrl | None
+    last_change_date: datetime
+    classifiers: list[ClassifierID]
+    dev: dict | None
+    quality: dict[str, Any]
+    workbench: NodesDict
+    ui: StudyUI | None
+    type: ProjectType
+    template_type: ProjectTemplateType | None
+
+    # config
+    model_config = ConfigDict(from_attributes=True, arbitrary_types_allowed=True)
+
+
 __all__: tuple[str, ...] = (
     "EmptyModel",
     "ProjectCopyOverride",

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

@@ -91,13 +91,14 @@ def _update_json_schema_extra(schema: JsonDict) -> None:
 
 class StudyUI(OutputSchema):
     # Model fully controlled by the UI and stored under `projects.ui`
-    icon: HttpUrl | None = None
+    icon: HttpUrl | None = None  # <-- Deprecated
 
     workbench: dict[NodeIDStr, WorkbenchUI] | None = None
     slideshow: dict[NodeIDStr, SlideshowUI] | None = None
     current_node_id: NodeID | None = None
     annotations: dict[NodeIDStr, AnnotationUI] | None = None
-    template_type: Literal["hypertool"] | None = None
+    template_type: Literal["hypertool"] | None = None  # <-- Deprecated
+    mode: Literal["workbench", "app", "guided", "standalone", "pipeline"] | None = None
 
     _empty_is_none = field_validator("*", mode="before")(
         empty_str_to_none_pre_validator

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

@@ -1,5 +1,6 @@
 from ..basic_types import IDStr
 from ..groups import GroupID
+from ..projects import ProjectID
 from ..users import UserID
 
 
@@ -15,3 +16,7 @@ def from_group_id(cls, group_id: GroupID) -> "SocketIORoomStr":
     @classmethod
     def from_user_id(cls, user_id: UserID) -> "SocketIORoomStr":
         return cls(f"user:{user_id}")
+
+    @classmethod
+    def from_project_id(cls, project_id: ProjectID) -> "SocketIORoomStr":
+        return cls(f"project:{project_id}")

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

@@ -164,7 +164,7 @@ class Node(BaseModel):
             ge=0,
             le=100,
             description="the node progress value (deprecated in DB, still used for API only)",
-            deprecated=True,
+            deprecated=True,  # <-- Think this is not true, it is still used by the File Picker (frontend nodes)
         ),
     ] = None
 

packages/pytest-simcore/pyproject.toml

@@ -12,9 +12,9 @@
 from common_library.async_tools import cancel_wait_task
 from models_library.api_schemas_long_running_tasks.base import TaskProgress
 from pydantic import PositiveFloat
-from servicelib.background_task import create_periodic_task
-from servicelib.logging_utils import log_catch
 
+from ..background_task import create_periodic_task
+from ..logging_utils import log_catch
 from .errors import (
     TaskAlreadyRunningError,
     TaskCancelledError,
@@ -33,7 +33,7 @@
 _DEFAULT_NAMESPACE: Final[str] = "lrt"
 
 _CANCEL_TASK_TIMEOUT: Final[PositiveFloat] = datetime.timedelta(
-    seconds=1
+    seconds=10  # NOTE: 1 second is too short to cleanup a task
 ).total_seconds()
 
 RegisteredTaskName: TypeAlias = str
@@ -196,7 +196,6 @@ def _add_task(
         *,
         fire_and_forget: bool,
     ) -> TrackedTask:
-
         tracked_task = TrackedTask(
             task_id=task_id,
             task=task,

packages/pytest-simcore/uv.lock

@@ -8,6 +8,11 @@
     ProjectLockError,
 )
 from ._models import RedisManagerDBConfig
+from ._project_document_version import (
+    PROJECT_DB_UPDATE_REDIS_LOCK_KEY,
+    PROJECT_DOCUMENT_VERSION_KEY,
+    increment_and_return_project_document_version,
+)
 from ._project_lock import (
     get_project_locked_state,
     is_project_locked,
@@ -19,10 +24,13 @@
     "CouldNotAcquireLockError",
     "CouldNotConnectToRedisError",
     "exclusive",
+    "increment_and_return_project_document_version",
     "get_project_locked_state",
     "handle_redis_returns_union_types",
     "is_project_locked",
     "LockLostError",
+    "PROJECT_DB_UPDATE_REDIS_LOCK_KEY",
+    "PROJECT_DOCUMENT_VERSION_KEY",
     "ProjectLockError",
     "RedisClientSDK",
     "RedisClientsManager",

packages/service-library/src/servicelib/long_running_tasks/task.py

@@ -0,0 +1,39 @@
+"""Project document versioning utilities.
+
+This module provides utilities for managing project document versions using Redis.
+The versioning system ensures that all users working on a project are synchronized
+with the latest changes through atomic version incrementing.
+"""
+
+from typing import Final
+
+from models_library.projects import ProjectID
+
+from ._client import RedisClientSDK
+
+# Redis key patterns
+PROJECT_DOCUMENT_VERSION_KEY: Final[str] = "projects:{}:version"
+PROJECT_DB_UPDATE_REDIS_LOCK_KEY: Final[str] = "project_db_update:{}"
+
+
+async def increment_and_return_project_document_version(
+    redis_client: RedisClientSDK, project_uuid: ProjectID
+) -> int:
+    """
+    Atomically increments and returns the project document version using Redis.
+    Returns the incremented version number.
+
+    This function ensures thread-safe version incrementing by using Redis INCR command
+    which is atomic. The version starts at 1 for the first call.
+
+    Args:
+        redis_client: The Redis client SDK instance
+        project_uuid: The project UUID to get/increment version for
+
+    Returns:
+        The new (incremented) version number
+    """
+    version_key = PROJECT_DOCUMENT_VERSION_KEY.format(project_uuid)
+    # If key doesn't exist, it's created with value 0 and then incremented to 1
+    output = await redis_client.redis.incr(version_key)
+    return int(output)

packages/service-library/src/servicelib/redis/__init__.py

@@ -0,0 +1,50 @@
+# pylint: disable=redefined-outer-name
+# pylint: disable=unused-argument
+
+from typing import cast
+from uuid import UUID
+
+import pytest
+from faker import Faker
+from models_library.projects import ProjectID
+from servicelib.redis import RedisClientSDK
+from servicelib.redis._project_document_version import (
+    increment_and_return_project_document_version,
+)
+
+pytest_simcore_core_services_selection = [
+    "redis",
+]
+pytest_simcore_ops_services_selection = [
+    "redis-commander",
+]
+
+
+@pytest.fixture()
+def project_uuid(faker: Faker) -> ProjectID:
+    return cast(UUID, faker.uuid4(cast_to=None))
+
+
+async def test_project_document_version_workflow(
+    redis_client_sdk: RedisClientSDK, project_uuid: ProjectID
+):
+    """Test the complete workflow of getting and incrementing project document versions."""
+
+    # First increment should return 1
+    new_version = await increment_and_return_project_document_version(
+        redis_client_sdk, project_uuid
+    )
+    assert new_version == 1
+
+    # Second increment should return 2
+    new_version = await increment_and_return_project_document_version(
+        redis_client_sdk, project_uuid
+    )
+    assert new_version == 2
+
+    # Multiple increments should work correctly
+    for expected_version in range(3, 6):
+        new_version = await increment_and_return_project_document_version(
+            redis_client_sdk, project_uuid
+        )
+        assert new_version == expected_version