✨ Refactor service key handling by consolidating key prefixes and regex patterns for improved maintainability

Author: pcrespov

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

@@ -15,55 +15,69 @@
 FILENAME_RE = r".+"
 
 
-# Add key prefixes for dynamic and computational services
-DYNAMIC_SERVICE_KEY_PREFIX: Final[str] = "simcore/services/dynamic"
-COMPUTATIONAL_SERVICE_KEY_PREFIX: Final[str] = "simcore/services/comp"
-FRONTEND_SERVICE_KEY_PREFIX: Final[str] = "simcore/services/frontend"
-
+SERVICE_TYPE_TO_NAME_MAP = MappingProxyType(
+    {
+        ServiceType.COMPUTATIONAL: "comp",
+        ServiceType.DYNAMIC: "dynamic",
+        ServiceType.FRONTEND: "frontend",
+    }
+)
 
+# e.g. simcore/services/comp/opencor
 SERVICE_KEY_RE: Final[re.Pattern[str]] = re.compile(
-    rf"^(?P<key_prefix>{COMPUTATIONAL_SERVICE_KEY_PREFIX}|{DYNAMIC_SERVICE_KEY_PREFIX}|{FRONTEND_SERVICE_KEY_PREFIX})"
-    r"/(?P<subdir>[a-z0-9][a-z0-9_.-]*/)*"
+    r"^simcore/services/"
+    rf"(?P<type>({ '|'.join(SERVICE_TYPE_TO_NAME_MAP.values()) }))/"
+    r"(?P<subdir>[a-z0-9][a-z0-9_.-]*/)*"
     r"(?P<name>[a-z0-9-_]+[a-z0-9])$"
 )
+
+# e.g. simcore%2Fservices%2Fcomp%2Fopencor
 SERVICE_ENCODED_KEY_RE: Final[re.Pattern[str]] = re.compile(
-    rf"^(?P<key_prefix>{COMPUTATIONAL_SERVICE_KEY_PREFIX.replace('/', '%2F')}|{DYNAMIC_SERVICE_KEY_PREFIX.replace('/', '%2F')}|{FRONTEND_SERVICE_KEY_PREFIX.replace('/', '%2F')})"
-    r"(?P<subdir>(%2F[a-z0-9][a-z0-9_.-]*)*%2F)?"
+    r"^simcore%2Fservices%2F"
+    rf"(?P<type>({'|'.join(SERVICE_TYPE_TO_NAME_MAP.values())}))%2F"
+    r"(?P<subdir>[a-z0-9][a-z0-9_.-]*%2F)*"
     r"(?P<name>[a-z0-9-_]+[a-z0-9])$"
 )
 
 
-DYNAMIC_SERVICE_KEY_RE: Final[re.Pattern[str]] = re.compile(
-    rf"^{DYNAMIC_SERVICE_KEY_PREFIX}/"
-    r"(?P<subdir>[a-z0-9][a-z0-9_.-]*/)*"
-    r"(?P<name>[a-z0-9-_]+[a-z0-9])$"
-)
-DYNAMIC_SERVICE_KEY_FORMAT: Final[str] = (
-    f"{DYNAMIC_SERVICE_KEY_PREFIX}/{{service_name}}"
-)
+def create_key_prefix(service_type: ServiceType) -> str:
+    return f"simcore/services/{SERVICE_TYPE_TO_NAME_MAP[service_type]}"
 
 
-COMPUTATIONAL_SERVICE_KEY_RE: Final[re.Pattern[str]] = re.compile(
-    rf"^{COMPUTATIONAL_SERVICE_KEY_PREFIX}/"
-    r"(?P<subdir>[a-z0-9][a-z0-9_.-]*/)*"
-    r"(?P<name>[a-z0-9-_]+[a-z0-9])$"
-)
-COMPUTATIONAL_SERVICE_KEY_FORMAT: Final[str] = (
-    f"{COMPUTATIONAL_SERVICE_KEY_PREFIX}/{{service_name}}"
+COMPUTATIONAL_SERVICE_KEY_PREFIX: Final[str] = create_key_prefix(
+    ServiceType.COMPUTATIONAL
 )
+DYNAMIC_SERVICE_KEY_PREFIX: Final[str] = create_key_prefix(ServiceType.DYNAMIC)
+FRONTEND_SERVICE_KEY_PREFIX: Final[str] = create_key_prefix(ServiceType.FRONTEND)
 
 
-FRONTEND_SERVICE_KEY_RE: Final[re.Pattern[str]] = re.compile(
-    rf"^{FRONTEND_SERVICE_KEY_PREFIX}/"
-    r"(?P<subdir>[a-z0-9][a-z0-9_.-]*/)*"
-    r"(?P<name>[a-z0-9-_]+[a-z0-9])$"
+def create_key_regex(service_type: ServiceType) -> re.Pattern[str]:
+    return re.compile(
+        rf"^simcore/services/{SERVICE_TYPE_TO_NAME_MAP[service_type]}/"
+        r"(?P<subdir>[a-z0-9][a-z0-9_.-]*/)*"
+        r"(?P<name>[a-z0-9-_]+[a-z0-9])$"
+    )
+
+
+def create_key_format(service_type: ServiceType) -> str:
+    return f"simcore/services/{SERVICE_TYPE_TO_NAME_MAP[service_type]}/{{service_name}}"
+
+
+COMPUTATIONAL_SERVICE_KEY_RE: Final[re.Pattern[str]] = create_key_regex(
+    ServiceType.COMPUTATIONAL
 )
-FRONTEND_SERVICE_KEY_FORMAT: Final[str] = (
-    f"{FRONTEND_SERVICE_KEY_PREFIX}/{{service_name}}"
+COMPUTATIONAL_SERVICE_KEY_FORMAT: Final[str] = create_key_format(
+    ServiceType.COMPUTATIONAL
 )
 
+DYNAMIC_SERVICE_KEY_RE: Final[re.Pattern[str]] = create_key_regex(ServiceType.DYNAMIC)
+DYNAMIC_SERVICE_KEY_FORMAT: Final[str] = create_key_format(ServiceType.DYNAMIC)
+
+FRONTEND_SERVICE_KEY_RE: Final[re.Pattern[str]] = create_key_regex(ServiceType.FRONTEND)
+FRONTEND_SERVICE_KEY_FORMAT: Final[str] = create_key_format(ServiceType.FRONTEND)
+
 
-SERVICE_TYPE_PREFIXES = MappingProxyType(
+SERVICE_TYPE_TO_PREFIX_MAP = MappingProxyType(
     {
         ServiceType.COMPUTATIONAL: COMPUTATIONAL_SERVICE_KEY_PREFIX,
         ServiceType.DYNAMIC: DYNAMIC_SERVICE_KEY_PREFIX,
@@ -72,5 +86,5 @@
 )
 
 assert all(  # nosec
-    not prefix.endswith("/") for prefix in SERVICE_TYPE_PREFIXES.values()
+    not prefix.endswith("/") for prefix in SERVICE_TYPE_TO_PREFIX_MAP.values()
 ), "Service type prefixes must not end with '/'"

packages/service-integration/src/service_integration/osparc_config.py

@@ -1,4 +1,4 @@
-""" 'osparc config' is a set of stardard file forms (yaml) that the user fills to describe how his/her service works and
+"""'osparc config' is a set of stardard file forms (yaml) that the user fills to describe how his/her service works and
 integrates with osparc.
 
     - config files are stored under '.osparc/' folder in the root repo folder (analogous to other configs like .github, .vscode, etc)
@@ -26,11 +26,7 @@
     RestartPolicy,
 )
 from models_library.service_settings_nat_rule import NATRule
-from models_library.services import BootOptions, ServiceMetaDataPublished, ServiceType
-from models_library.services_regex import (
-    COMPUTATIONAL_SERVICE_KEY_FORMAT,
-    DYNAMIC_SERVICE_KEY_FORMAT,
-)
+from models_library.services import BootOptions, ServiceMetaDataPublished
 from models_library.services_types import ServiceKey
 from models_library.utils.labels_annotations import (
     OSPARC_LABEL_PREFIXES,
@@ -62,12 +58,6 @@
 OSPARC_CONFIG_RUNTIME_NAME: Final[str] = "runtime.yml"
 
 
-SERVICE_KEY_FORMATS = {
-    ServiceType.COMPUTATIONAL: COMPUTATIONAL_SERVICE_KEY_FORMAT,
-    ServiceType.DYNAMIC: DYNAMIC_SERVICE_KEY_FORMAT,
-}
-
-
 class DockerComposeOverwriteConfig(ComposeSpecification):
     """Content of docker-compose.overwrite.yml configuration file"""
 
@@ -231,9 +221,9 @@ class RuntimeConfig(BaseModel):
 
     containers_allowed_outgoing_internet: set[str] | None = None
 
-    settings: Annotated[
-        list[SettingsItem], Field(default_factory=list)
-    ] = DEFAULT_FACTORY
+    settings: Annotated[list[SettingsItem], Field(default_factory=list)] = (
+        DEFAULT_FACTORY
+    )
 
     @model_validator(mode="before")
     @classmethod

services/catalog/src/simcore_service_catalog/repository/_services_sql.py

@@ -3,7 +3,7 @@
 import sqlalchemy as sa
 from models_library.products import ProductName
 from models_library.services_regex import (
-    SERVICE_TYPE_PREFIXES,
+    SERVICE_TYPE_TO_PREFIX_MAP,
 )
 from models_library.services_types import ServiceKey, ServiceVersion
 from models_library.users import UserID
@@ -121,7 +121,7 @@ def apply_services_filters(
     filters: ServiceFiltersDB,
 ):
     if filters.service_type:
-        prefix = SERVICE_TYPE_PREFIXES.get(filters.service_type)
+        prefix = SERVICE_TYPE_TO_PREFIX_MAP.get(filters.service_type)
         if prefix is None:
             msg = f"Undefined service type {filters.service_type}. Please update prefix expressions"
             raise ValueError(msg)

services/catalog/tests/unit/with_dbs/test_repositories.py

@@ -17,7 +17,7 @@
 from models_library.services_regex import (
     COMPUTATIONAL_SERVICE_KEY_PREFIX,
     DYNAMIC_SERVICE_KEY_PREFIX,
-    SERVICE_TYPE_PREFIXES,
+    SERVICE_TYPE_TO_PREFIX_MAP,
 )
 from models_library.users import UserID
 from packaging import version
@@ -633,7 +633,7 @@ async def test_get_service_history_page(
 
 
 @pytest.mark.parametrize(
-    "expected_service_type,service_prefix", SERVICE_TYPE_PREFIXES.items()
+    "expected_service_type,service_prefix", SERVICE_TYPE_TO_PREFIX_MAP.items()
 )
 async def test_get_service_history_page_with_filters(
     target_product: ProductName,