refactor project lock

Author: matusdrobuliak66

packages/service-library/src/servicelib/project_lock.py

@@ -6,6 +6,7 @@
 from typing import Final
 
 import redis
+import redis.exceptions
 from models_library.projects import ProjectID
 from models_library.projects_access import Owner
 from models_library.projects_state import ProjectLocked, ProjectStatus

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

@@ -2,9 +2,9 @@
 
 from typing import Any
 
-import redis.exceptions
 from models_library.projects import ProjectID
 from models_library.users import UserID
+from servicelib.project_lock import ProjectLockError
 
 from ..errors import WebServerBaseError
 
@@ -104,9 +104,6 @@ def __init__(self, *, project_uuid: str | None, **ctx):
         self.project_uuid = project_uuid
 
 
-ProjectLockError = redis.exceptions.LockError
-
-
 class ProjectStartsTooManyDynamicNodesError(BaseProjectError):
     msg_template = "The maximal amount of concurrently running dynamic services was reached. Please manually stop a service and retry."
 
@@ -224,3 +221,7 @@ class InvalidInputValue(WebServerBaseError):
 
 class ProjectGroupNotFoundError(BaseProjectError):
     msg_template = "Project group not found. {reason}"
+
+
+assert ProjectLockError  # nosec
+__all__: tuple[str, ...] = ("ProjectLockError",)

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

@@ -1,34 +1,21 @@
-import datetime
 import logging
-from asyncio.log import logger
 from collections.abc import AsyncIterator
 from contextlib import asynccontextmanager
-from typing import Final
 
-import redis
 from aiohttp import web
 from models_library.projects import ProjectID
 from models_library.projects_access import Owner
 from models_library.projects_state import ProjectLocked, ProjectStatus
-from redis.asyncio.lock import Lock
-from servicelib.background_task import periodic_task
-from servicelib.logging_utils import log_context
+
+# from .exceptions import ProjectLockError
+from servicelib.project_lock import PROJECT_LOCK_TIMEOUT, PROJECT_REDIS_LOCK_KEY
+from servicelib.project_lock import lock_project as common_lock_project
 
 from ..redis import get_redis_lock_manager_client
 from ..users.api import FullNameDict
-from .exceptions import ProjectLockError
 
 _logger = logging.getLogger(__name__)
 
-PROJECT_REDIS_LOCK_KEY: str = "project_lock:{}"
-PROJECT_LOCK_TIMEOUT: Final[datetime.timedelta] = datetime.timedelta(seconds=10)
-ProjectLock = Lock
-
-
-async def _auto_extend_project_lock(project_lock: Lock) -> None:
-    # NOTE: the background task already catches anything that might raise here
-    await project_lock.reacquire()
-
 
 @asynccontextmanager
 async def lock_project(
@@ -48,42 +35,12 @@ async def lock_project(
         PROJECT_REDIS_LOCK_KEY.format(project_uuid),
         timeout=PROJECT_LOCK_TIMEOUT.total_seconds(),
     )
-    try:
-        if not await redis_lock.acquire(
-            blocking=False,
-            token=ProjectLocked(
-                value=True,
-                owner=Owner(user_id=user_id, **user_fullname),  # type: ignore[arg-type]
-                status=status,
-            ).json(),
-        ):
-            msg = f"Lock for project {project_uuid!r} user {user_id!r} could not be acquired"
-            raise ProjectLockError(msg)
-
-        with log_context(
-            _logger,
-            logging.DEBUG,
-            msg=f"with lock for {user_id=}:{user_fullname=}:{project_uuid=}:{status=}",
-        ):
-            async with periodic_task(
-                _auto_extend_project_lock,
-                interval=0.6 * PROJECT_LOCK_TIMEOUT,
-                task_name=f"{PROJECT_REDIS_LOCK_KEY.format(project_uuid)}_lock_auto_extend",
-                project_lock=redis_lock,
-            ):
-                yield
+    owner = Owner(user_id=user_id, **user_fullname)  # type: ignore[arg-type]
 
-    finally:
-        # let's ensure we release that stuff
-        try:
-            if await redis_lock.owned():
-                await redis_lock.release()
-        except (redis.exceptions.LockError, redis.exceptions.LockNotOwnedError) as exc:
-            logger.warning(
-                "releasing %s unexpectedly raised an exception: %s",
-                f"{redis_lock=!r}",
-                f"{exc}",
-            )
+    async with common_lock_project(
+        redis_lock, project_uuid=project_uuid, status=status, owner=owner
+    ):
+        yield
 
 
 async def is_project_locked(