refactoring

Author: sanderegg

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

@@ -55,3 +55,26 @@ async def _exclusive_func(*args, **kwargs) -> R:
         return _wrapper
 
     return _decorator
+
+
+async def is_project_locked(
+    redis_client: RedisClientSDK, project_uuid: str | ProjectID
+) -> bool:
+    redis_lock = redis_client.create_lock(PROJECT_REDIS_LOCK_KEY.format(project_uuid))
+    return await redis_lock.locked()
+
+
+async def get_project_locked_state(
+    redis_client: RedisClientSDK, project_uuid: str | ProjectID
+) -> ProjectLocked | None:
+    """
+    Returns:
+        ProjectLocked object if the project project_uuid is locked or None otherwise
+    """
+    if await is_project_locked(redis_client, project_uuid=project_uuid) and (
+        lock_value := await redis_client.redis.get(
+            PROJECT_REDIS_LOCK_KEY.format(project_uuid)
+        )
+    ):
+        return ProjectLocked.model_validate_json(lock_value)
+    return None

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

@@ -1,4 +1,4 @@
-""" Handlers for STANDARD methods on /projects colletions
+"""Handlers for STANDARD methods on /projects colletions
 
 Standard methods or CRUD that states for Create+Read(Get&List)+Update+Delete
 
@@ -36,12 +36,14 @@
     X_SIMCORE_USER_AGENT,
 )
 from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
+from servicelib.project_lock import get_project_locked_state
 from servicelib.rest_constants import RESPONSE_MODEL_POLICY
 
 from .._meta import API_VTAG as VTAG
 from ..catalog.client import get_services_for_user_in_product
 from ..folders.errors import FolderAccessForbiddenError, FolderNotFoundError
 from ..login.decorators import login_required
+from ..redis import get_redis_lock_manager_client_sdk
 from ..resource_manager.user_sessions import PROJECT_ID_KEY, managed_resource
 from ..security.api import check_user_permission
 from ..security.decorators import permission_required
@@ -65,7 +67,6 @@
     ProjectOwnerNotFoundInTheProjectAccessRightsError,
     WrongTagIdsInQueryError,
 )
-from .lock import get_project_locked_state
 from .models import ProjectDict
 from .utils import get_project_unavailable_services, project_uses_available_services
 
@@ -139,7 +140,8 @@ async def create_project(request: web.Request):
         project_create: (
             ProjectCreateNew | ProjectCopyOverride | EmptyModel
         ) = await parse_request_body_as(
-            ProjectCreateNew | ProjectCopyOverride | EmptyModel, request  # type: ignore[arg-type] # from pydantic v2 --> https://github.com/pydantic/pydantic/discussions/4950
+            ProjectCreateNew | ProjectCopyOverride | EmptyModel,
+            request,  # type: ignore[arg-type] # from pydantic v2 --> https://github.com/pydantic/pydantic/discussions/4950
         )
         predefined_project = (
             project_create.model_dump(
@@ -457,7 +459,7 @@ async def delete_project(request: web.Request):
             )
         if project_users:
             other_user_names = {
-                await get_user_fullname(request.app, user_id=uid)
+                f"{await get_user_fullname(request.app, user_id=uid)}"
                 for uid in project_users
             }
             raise web.HTTPForbidden(
@@ -467,7 +469,8 @@ async def delete_project(request: web.Request):
 
         project_locked_state: ProjectLocked | None
         if project_locked_state := await get_project_locked_state(
-            app=request.app, project_uuid=path_params.project_id
+            get_redis_lock_manager_client_sdk(request.app),
+            project_uuid=path_params.project_id,
         ):
             raise web.HTTPConflict(
                 reason=f"Project {path_params.project_id} is locked: {project_locked_state=}"

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

@@ -72,6 +72,11 @@
     X_SIMCORE_USER_AGENT,
 )
 from servicelib.logging_utils import get_log_record_extra, log_context
+from servicelib.project_lock import (
+    get_project_locked_state,
+    is_project_locked,
+    with_project_locked,
+)
 from servicelib.rabbitmq import RemoteMethodNotRegisteredError, RPCServerError
 from servicelib.rabbitmq.rpc_interfaces.catalog import services as catalog_rpc
 from servicelib.rabbitmq.rpc_interfaces.clusters_keeper.ec2_instances import (
@@ -145,11 +150,6 @@
     ProjectStartsTooManyDynamicNodesError,
     ProjectTooManyProjectOpenedError,
 )
-from .lock import (
-    get_project_locked_state,
-    is_project_locked,
-    with_locked_project_from_app,
-)
 from .models import ProjectDict, ProjectPatchExtended
 from .settings import ProjectsSettings, get_plugin_settings
 from .utils import extract_dns_without_default_port
@@ -286,7 +286,7 @@ async def patch_project(
             "delete": True,
         }
         user: dict = await get_user(app, project_db.prj_owner)
-        _prj_owner_primary_group = f'{user["primary_gid"]}'
+        _prj_owner_primary_group = f"{user['primary_gid']}"
         if _prj_owner_primary_group not in new_prj_access_rights:
             raise ProjectOwnerNotFoundInTheProjectAccessRightsError
         if new_prj_access_rights[_prj_owner_primary_group] != _prj_required_permissions:
@@ -1154,7 +1154,7 @@ async def _trigger_connected_service_retrieve(
     app: web.Application, project: dict, updated_node_uuid: str, changed_keys: list[str]
 ) -> None:
     project_id = project["uuid"]
-    if await is_project_locked(app, project_id):
+    if await is_project_locked(get_redis_lock_manager_client_sdk(app), project_id):
         # NOTE: we log warn since this function is fire&forget and raise an exception would not be anybody to handle it
         log.warning(
             "Skipping service retrieval because project with %s is currently locked."
@@ -1409,7 +1409,7 @@ async def _get_project_lock_state(
         f"{user_id=}",
     )
     prj_locked_state: ProjectLocked | None = await get_project_locked_state(
-        app, project_uuid
+        get_redis_lock_manager_client_sdk(app), project_uuid
     )
     if prj_locked_state:
         log.debug(
@@ -1880,12 +1880,11 @@ def _decorator(
     ) -> Callable[P, Coroutine[Any, Any, R]]:
         @wraps(func)
         async def _wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
-            @with_locked_project_from_app(
-                app,
+            @with_project_locked(
+                get_redis_lock_manager_client_sdk(app),
                 project_uuid=project_uuid,
                 status=status,
-                user_id=user_id,
-                user_fullname=user_name,
+                owner=Owner(user_id=user_id, **user_name),
             )
             async def _locked_func() -> R:
                 if notify_users: