@bisgaard-itis review: validations

Author: pcrespov

services/api-server/src/simcore_service_api_server/_service_jobs.py

@@ -16,7 +16,6 @@
 from pydantic import HttpUrl
 from servicelib.logging_utils import log_context
 
-from .exceptions.custom_errors import ServiceConfigurationError
 from .models.schemas.jobs import Job, JobInputs
 from .models.schemas.programs import Program
 from .models.schemas.solvers import Solver
@@ -142,21 +141,3 @@ async def create_job(
             job_id=job.id,
         )
         return job, new_project
-
-
-def check_user_product_consistency(
-    service_cls_name: str,
-    job_service: JobService,
-    user_id: UserID,
-    product_name: ProductName,
-) -> None:
-    if user_id != job_service.user_id:
-        msg = f"User ID {user_id} does not match job service user ID {job_service.user_id}"
-        raise ServiceConfigurationError(
-            service_cls_name=service_cls_name, detail_msg=msg
-        )
-    if product_name != job_service.product_name:
-        msg = f"Product name {product_name} does not match job service product name {job_service.product_name}"
-        raise ServiceConfigurationError(
-            service_cls_name=service_cls_name, detail_msg=msg
-        )

services/api-server/src/simcore_service_api_server/_service_solvers.py

@@ -13,7 +13,8 @@
 from models_library.users import UserID
 from pydantic import NonNegativeInt, PositiveInt
 
-from ._service_jobs import JobService, check_user_product_consistency
+from ._service_jobs import JobService
+from ._service_utils import check_user_product_consistency
 from .exceptions.backend_errors import (
     ProgramOrSolverOrStudyNotFoundError,
 )
@@ -36,12 +37,18 @@ class SolverService:
     product_name: ProductName
 
     def __post_init__(self):
-        # Context check
         check_user_product_consistency(
             service_cls_name=self.__class__.__name__,
+            service_provider=self.catalog_service,
+            user_id=self.user_id,
+            product_name=self.product_name,
+        )
+
+        check_user_product_consistency(
+            service_cls_name=self.__class__.__name__,
+            service_provider=self.job_service,
             user_id=self.user_id,
             product_name=self.product_name,
-            job_service=self.job_service,
         )
 
     async def get_solver(

services/api-server/src/simcore_service_api_server/_service_studies.py

@@ -9,7 +9,8 @@
 from models_library.rpc_pagination import PageLimitInt
 from models_library.users import UserID
 
-from ._service_jobs import JobService, check_user_product_consistency
+from ._service_jobs import JobService
+from ._service_utils import check_user_product_consistency
 from .models.api_resources import compose_resource_name
 from .models.schemas.jobs import Job
 from .models.schemas.studies import StudyID
@@ -24,12 +25,11 @@ class StudyService:
     product_name: ProductName
 
     def __post_init__(self):
-        # Context check
         check_user_product_consistency(
             service_cls_name=self.__class__.__name__,
+            service_provider=self.job_service,
             user_id=self.user_id,
             product_name=self.product_name,
-            job_service=self.job_service,
         )
 
     async def list_jobs(

services/api-server/src/simcore_service_api_server/_service_utils.py

@@ -0,0 +1,35 @@
+from typing import Protocol
+
+from models_library.products import ProductName
+from models_library.users import UserID
+
+from .exceptions.custom_errors import ServiceConfigurationError
+
+
+class UserProductProvider(Protocol):
+    """Protocol for classes that provide user_id and product_name properties."""
+
+    @property
+    def user_id(self) -> UserID: ...
+
+    @property
+    def product_name(self) -> ProductName: ...
+
+
+def check_user_product_consistency(
+    service_cls_name: str,
+    service_provider: UserProductProvider,
+    user_id: UserID,
+    product_name: ProductName,
+) -> None:
+
+    if user_id != service_provider.user_id:
+        msg = f"User ID {user_id} does not match {service_provider.__class__.__name__} user ID {service_provider.user_id}"
+        raise ServiceConfigurationError(
+            service_cls_name=service_cls_name, detail_msg=msg
+        )
+    if product_name != service_provider.product_name:
+        msg = f"Product name {product_name} does not match {service_provider.__class__.__name__}product name {service_provider.product_name}"
+        raise ServiceConfigurationError(
+            service_cls_name=service_cls_name, detail_msg=msg
+        )