refactor duplication

Author: matusdrobuliak66

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

@@ -8,6 +8,12 @@
     ProjectLockError,
 )
 from ._models import RedisManagerDBConfig
+from ._project_document_version import (
+    PROJECT_DB_UPDATE_REDIS_LOCK_KEY,
+    PROJECT_DOCUMENT_VERSION_KEY,
+    get_and_increment_project_document_version,
+    get_project_document_version,
+)
 from ._project_lock import (
     get_project_locked_state,
     is_project_locked,
@@ -19,15 +25,17 @@
     "CouldNotAcquireLockError",
     "CouldNotConnectToRedisError",
     "exclusive",
+    "get_and_increment_project_document_version",
+    "get_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",
     "RedisManagerDBConfig",
     "with_project_locked",
 )
-
-# nopycln: file

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

@@ -0,0 +1,56 @@
+"""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 get_and_increment_project_document_version(
+    redis_client: RedisClientSDK, project_uuid: ProjectID
+) -> int:
+    """
+    Atomically gets and increments 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
+    return await redis_client.redis.incr(version_key)
+
+
+async def get_project_document_version(
+    redis_client: RedisClientSDK, project_uuid: ProjectID
+) -> int:
+    """
+    Gets the current project document version without incrementing it.
+
+    Args:
+        redis_client: The Redis client SDK instance
+        project_uuid: The project UUID to get version for
+
+    Returns:
+        The current version number (0 if no version exists yet)
+    """
+    version_key = PROJECT_DOCUMENT_VERSION_KEY.format(project_uuid)
+    version = await redis_client.redis.get(version_key)
+    return int(version) if version is not None else 0

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

@@ -44,7 +44,11 @@
 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 exclusive
+from servicelib.redis import (
+    PROJECT_DB_UPDATE_REDIS_LOCK_KEY,
+    exclusive,
+    get_and_increment_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
@@ -78,7 +82,10 @@
 from tenacity.asyncio import AsyncRetrying
 from tenacity.retry import retry_if_exception_type
 
-from ..redis import get_redis_lock_manager_client_sdk
+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 (
@@ -122,32 +129,6 @@
     field=IDStr("last_change_date"), direction=OrderDirection.DESC
 )
 
-# Project locking and versioning constants
-PROJECT_DOCUMENT_VERSION_KEY: str = "projects:{}:version"
-PROJECT_DB_UPDATE_REDIS_LOCK_KEY: str = "project_db_update:{}"
-
-
-async def _get_and_increment_project_document_version(
-    app: web.Application, project_uuid: ProjectID
-) -> int:
-    """
-    Atomically gets and increments the project document version using Redis.
-    Returns the incremented version number.
-
-    Args:
-        app: The web application instance
-        project_uuid: The project UUID to get/increment version for
-
-    Returns:
-        The new (incremented) version number
-    """
-    from ..redis import get_redis_document_manager_client_sdk
-
-    redis_client_sdk = get_redis_document_manager_client_sdk(app)
-    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
-    return await redis_client_sdk.redis.incr(version_key)
-
 
 # pylint: disable=too-many-public-methods
 # NOTE: https://github.com/ITISFoundation/osparc-simcore/issues/3516
@@ -995,8 +976,9 @@ async def _update_workbench_and_notify() -> (
             )
 
             # Increment document version and notify users
-            document_version = await _get_and_increment_project_document_version(
-                app=self._app, project_uuid=project_uuid
+            redis_client_sdk = get_redis_document_manager_client_sdk(self._app)
+            document_version = await get_and_increment_project_document_version(
+                redis_client=redis_client_sdk, project_uuid=project_uuid
             )
             await notify_project_document_updated(
                 app=self._app,

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

@@ -84,7 +84,9 @@
     ServiceWasNotFoundError,
 )
 from servicelib.redis import (
+    PROJECT_DB_UPDATE_REDIS_LOCK_KEY,
     exclusive,
+    get_and_increment_project_document_version,
     get_project_locked_state,
     is_project_locked,
     with_project_locked,
@@ -168,33 +170,6 @@
 
 log = logging.getLogger(__name__)
 
-PROJECT_DOCUMENT_VERSION_KEY: str = "projects:{}:version"
-PROJECT_DB_UPDATE_REDIS_LOCK_KEY: str = "project_db_update:{}"
-
-
-async def _get_and_increment_project_document_version(
-    app: web.Application, project_uuid: ProjectID
-) -> int:
-    """
-    Atomically gets and increments the project document version using Redis.
-
-    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:
-        app: The web application instance
-        project_uuid: The project UUID
-
-    Returns:
-        The new incremented version number
-    """
-    redis_client_sdk = get_redis_document_manager_client_sdk(app)
-    version_key = PROJECT_DOCUMENT_VERSION_KEY.format(project_uuid)
-
-    # Redis INCR is atomic and returns the new value
-    # If key doesn't exist, it's created with value 0 and then incremented to 1
-    return await redis_client_sdk.redis.incr(version_key)
-
 
 async def patch_project_and_notify_users(
     app: web.Application,
@@ -256,8 +231,9 @@ async def _patch_and_notify() -> None:
                 ProjectTemplateType, project_with_workbench.template_type
             ),
         )
-        document_version = await _get_and_increment_project_document_version(
-            app=app, project_uuid=project_uuid
+        redis_client_sdk = get_redis_document_manager_client_sdk(app)
+        document_version = await get_and_increment_project_document_version(
+            redis_client=redis_client_sdk, project_uuid=project_uuid
         )
         await notify_project_document_updated(
             app=app,

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

@@ -9,8 +9,6 @@
 
 from ..socketio.messages import send_message_to_project_room
 
-# SOCKET_IO_PROJECT_CREATED_EVENT: Final[str] = "projectDocument:created"
-# SOCKET_IO_PROJECT_DELETED_EVENT: Final[str] = "projectDocument:deleted"
 SOCKET_IO_PROJECT_DOCUMENT_UPDATED_EVENT: Final[str] = "projectDocument:updated"
 
 
@@ -31,33 +29,6 @@ class ProjectDocumentEvent(BaseEvent):
     document: ProjectDocument
 
 
-# async def notify_project_created(
-#     app: web.Application,
-#     *,
-#     project_id: ProjectID,
-#     product_name: ProductName,
-#     user_group_id: GroupID,
-#     project_name: str,
-#     created: datetime.datetime,
-#     modified: datetime.datetime,
-# ) -> None:
-#     notification_message = SocketMessageDict(
-#         event_type=SOCKET_IO_PROJECT_CREATED_EVENT,
-#         data={
-#             **ProjectCreatedOrUpdatedEvent(
-#                 product_name=product_name,
-#                 project_id=project_id,
-#                 user_group_id=user_group_id,
-#                 name=project_name,
-#                 created=created,
-#                 modified=modified,
-#             ).model_dump(mode="json", by_alias=True),
-#         },
-#     )
-
-#     await send_message_to_project_room(app, project_id, notification_message)
-
-
 async def notify_project_document_updated(
     app: web.Application,
     *,
@@ -78,24 +49,3 @@ async def notify_project_document_updated(
         },
     )
     await send_message_to_project_room(app, project_id, notification_message)
-
-
-# async def notify_project_deleted(
-#     app: web.Application,
-#     *,
-#     project_id: ProjectID,
-#     product_name: ProductName,
-#     user_group_id: GroupID,
-# ) -> None:
-#     notification_message = SocketMessageDict(
-#         event_type=SOCKET_IO_PROJECT_DELETED_EVENT,
-#         data={
-#             **ProjectDeletedEvent(
-#                 product_name=product_name,
-#                 project_id=project_id,
-#                 user_group_id=user_group_id,
-#             ).model_dump(mode="json", by_alias=True),
-#         },
-#     )
-
-#     await send_message_to_project_room(app, project_id, notification_message)