🎨 Ensure consistent app names across simcore stack (ITISFoundation#8119)

bisgaard-itis · web-flow · commit 289f936f5448 · 2025-07-17T20:53:02.000Z
diff --git a/packages/service-library/src/servicelib/utils_meta.py b/packages/service-library/src/servicelib/utils_meta.py
@@ -1,13 +1,16 @@
-"""  Utilities to implement _meta.py
-
-"""
+"""Utilities to implement _meta.py"""
 
+import re
 from importlib.metadata import distribution
 
 from models_library.basic_types import VersionStr
 from packaging.version import Version
 from pydantic import TypeAdapter
 
+_APP_NAME_PATTERN = re.compile(
+    r"^[a-z0-9]+(-[a-z0-9]+)*$"
+)  # matches lowercase string with words and non-negative integers separated by dashes (no whitespace)
+
 
 class PackageInfo:
     """Thin wrapper around pgk_resources.Distribution to access package distribution metadata
@@ -29,11 +32,31 @@ def __init__(self, package_name: str):
         package_name: as defined in 'setup.name'
         """
         self._distribution = distribution(package_name)
+        # property checks
+        if re.match(_APP_NAME_PATTERN, self.app_name) is None:
+            raise ValueError(
+                f"Invalid package name {self.app_name}. "
+                "It must be all lowercase and words separated by dashes ('-')."
+            )
 
     @property
     def project_name(self) -> str:
         return self._distribution.metadata["Name"]
 
+    @property
+    def app_name(self) -> str:
+        """
+        Returns the application name as a lowercase string with words separated by dashes ('-').
+        """
+        return self._distribution.metadata["Name"]
+
+    @property
+    def prometheus_friendly_app_name(self) -> str:
+        """
+        Returns a version of the app name which is compatible with Prometheus metrics naming conventions (no dashes).
+        """
+        return self.app_name.replace("-", "_")
+
     @property
     def version(self) -> Version:
         return Version(self._distribution.version)
diff --git a/packages/service-library/tests/test_utils_meta.py b/packages/service-library/tests/test_utils_meta.py
@@ -1,7 +1,9 @@
 from typing import Final
 
+import pytest
 from models_library.basic_types import VersionStr
 from packaging.version import Version
+from pytest_mock import MockerFixture
 from servicelib.utils_meta import PackageInfo
 
 
@@ -32,3 +34,33 @@ def test_meta_module_implementation():
 
     assert __version__ in APP_FINISHED_BANNER_MSG
     assert PROJECT_NAME in APP_FINISHED_BANNER_MSG
+
+
+@pytest.mark.parametrize(
+    "package_name, app_name, is_valid_app_name, is_correct_app_name",
+    [
+        ("simcore-service-library", "simcore-service-library", True, True),
+        ("simcore-service-lib", "simcore-service-library", True, False),
+        ("simcore_service_library", "simcore_service_library", False, True),
+    ],
+)
+def test_app_name(
+    mocker: MockerFixture,
+    package_name: str,
+    app_name: str,
+    is_valid_app_name: bool,
+    is_correct_app_name: bool,
+):
+
+    def mock_distribution(name):
+        return mocker.Mock(metadata={"Name": name, "Version": "1.0.0"})
+
+    mocker.patch("servicelib.utils_meta.distribution", side_effect=mock_distribution)
+    if is_valid_app_name:
+        info = PackageInfo(package_name=package_name)
+        if is_correct_app_name:
+            assert info.app_name == app_name
+            assert info.prometheus_friendly_app_name == app_name.replace("-", "_")
+    else:
+        with pytest.raises(ValueError):
+            _ = PackageInfo(package_name=package_name)
diff --git a/services/api-server/src/simcore_service_api_server/_meta.py b/services/api-server/src/simcore_service_api_server/_meta.py
@@ -1,7 +1,4 @@
-""" Application's metadata
-
-"""
-
+"""Application's metadata"""
 
 from typing import Final
 
@@ -17,7 +14,7 @@
 VERSION: Final[Version] = info.version
 API_VERSION: Final[VersionStr] = info.__version__
 API_VTAG: Final[str] = info.api_prefix_path_tag
-APP_NAME: Final[str] = PROJECT_NAME
+APP_NAME: Final[str] = info.app_name
 SUMMARY: Final[str] = info.get_summary()
 
 
diff --git a/services/autoscaling/src/simcore_service_autoscaling/_meta.py b/services/autoscaling/src/simcore_service_autoscaling/_meta.py
@@ -8,7 +8,7 @@
 info: Final = PackageInfo(package_name="simcore-service-autoscaling")
 __version__: Final[VersionStr] = info.__version__
 
-APP_NAME: Final[str] = info.project_name
+APP_NAME: Final[str] = info.app_name
 API_VERSION: Final[VersionStr] = info.__version__
 VERSION: Final[Version] = info.version
 API_VTAG: Final[VersionTag] = TypeAdapter(VersionTag).validate_python(
diff --git a/services/catalog/src/simcore_service_catalog/_meta.py b/services/catalog/src/simcore_service_catalog/_meta.py
@@ -12,7 +12,7 @@
 VERSION: Final[Version] = info.version
 API_VERSION: Final[VersionStr] = info.__version__
 API_VTAG: Final[str] = info.api_prefix_path_tag
-APP_NAME: Final[str] = info.project_name
+APP_NAME: Final[str] = info.app_name
 SUMMARY: Final[str] = info.get_summary()
 
 
diff --git a/services/dask-sidecar/src/simcore_service_dask_sidecar/_meta.py b/services/dask-sidecar/src/simcore_service_dask_sidecar/_meta.py
@@ -1,15 +1,12 @@
-""" Application's metadata
-
-"""
-
+"""Application's metadata"""
 
 from typing import Final
 
 import dask
 from models_library.basic_types import VersionStr
 from servicelib.utils_meta import PackageInfo
 
-info: Final = PackageInfo(package_name="simcore_service_dask_sidecar")
+info: Final = PackageInfo(package_name="simcore-service-dask-sidecar")
 __version__: Final[VersionStr] = info.__version__
 
 
diff --git a/services/director-v2/src/simcore_service_director_v2/_meta.py b/services/director-v2/src/simcore_service_director_v2/_meta.py
@@ -14,5 +14,5 @@
 VERSION: Final[Version] = info.version
 API_VERSION: Final[VersionStr] = info.__version__
 API_VTAG: Final[str] = info.api_prefix_path_tag
-APP_NAME: Final[str] = PROJECT_NAME
+APP_NAME: Final[str] = info.app_name
 SUMMARY: Final[str] = info.get_summary()
diff --git a/services/director/src/simcore_service_director/_meta.py b/services/director/src/simcore_service_director/_meta.py
@@ -1,6 +1,4 @@
-""" Application's metadata
-
-"""
+"""Application's metadata"""
 
 from typing import Final
 
@@ -15,7 +13,7 @@
 PROJECT_NAME: Final[str] = info.project_name
 VERSION: Final[Version] = info.version
 API_VERSION: Final[VersionStr] = info.__version__
-APP_NAME: Final[str] = PROJECT_NAME
+APP_NAME: Final[str] = info.app_name
 API_VTAG: Final[VersionTag] = VersionTag(info.api_prefix_path_tag)
 SUMMARY: Final[str] = info.get_summary()
 
diff --git a/services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/_meta.py b/services/dynamic-scheduler/src/simcore_service_dynamic_scheduler/_meta.py
@@ -1,6 +1,5 @@
-""" Application's metadata
+"""Application's metadata"""
 
-"""
 from typing import Final
 
 from models_library.basic_types import VersionStr
@@ -14,7 +13,7 @@
 PROJECT_NAME: Final[str] = info.project_name
 VERSION: Final[Version] = info.version
 API_VERSION: Final[VersionStr] = info.__version__
-APP_NAME = PROJECT_NAME
+APP_NAME: Final[str] = info.app_name
 API_VTAG: Final[str] = info.api_prefix_path_tag
 SUMMARY: Final[str] = info.get_summary()
 
diff --git a/services/invitations/src/simcore_service_invitations/_meta.py b/services/invitations/src/simcore_service_invitations/_meta.py
@@ -1,6 +1,4 @@
-""" Application's metadata
-
-"""
+"""Application's metadata"""
 
 from typing import Final
 
@@ -16,7 +14,7 @@
 PROJECT_NAME: Final[str] = info.project_name
 VERSION: Final[Version] = info.version
 API_VERSION: Final[VersionStr] = info.__version__
-APP_NAME = PROJECT_NAME
+APP_NAME: Final[str] = info.app_name
 API_VTAG: Final[VersionTag] = VersionTag(info.api_prefix_path_tag)
 SUMMARY: Final[str] = info.get_summary()
 
diff --git a/services/payments/src/simcore_service_payments/_meta.py b/services/payments/src/simcore_service_payments/_meta.py
@@ -1,6 +1,5 @@
-""" Application's metadata
+"""Application's metadata"""
 
-"""
 from typing import Final
 
 from models_library.basic_types import VersionStr
@@ -14,7 +13,7 @@
 PROJECT_NAME: Final[str] = info.project_name
 VERSION: Final[Version] = info.version
 API_VERSION: Final[VersionStr] = info.__version__
-APP_NAME: Final[str] = PROJECT_NAME
+APP_NAME: Final[str] = info.app_name
 API_VTAG: Final[str] = info.api_prefix_path_tag
 SUMMARY: Final[str] = info.get_summary()
 
diff --git a/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/_meta.py b/services/resource-usage-tracker/src/simcore_service_resource_usage_tracker/_meta.py
@@ -1,6 +1,4 @@
-""" Application's metadata
-
-"""
+"""Application's metadata"""
 
 from typing import Final
 
@@ -21,7 +19,7 @@
     info.api_prefix_path_tag
 )
 SUMMARY: Final[str] = info.get_summary()
-APP_NAME: Final[str] = PROJECT_NAME
+APP_NAME: Final[str] = info.app_name
 
 # NOTE: https://texteditor.com/ascii-frames/
 APP_STARTED_BANNER_MSG = r"""
diff --git a/services/storage/openapi.json b/services/storage/openapi.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.1.0",
   "info": {
-    "title": "simcore_service_storage",
+    "title": "simcore-service-storage",
     "description": "Service that manages osparc storage backend",
     "version": "0.7.1"
   },
diff --git a/services/storage/src/simcore_service_storage/_meta.py b/services/storage/src/simcore_service_storage/_meta.py
@@ -13,7 +13,7 @@
 API_VERSION: Final[VersionStr] = info.__version__
 API_VTAG: Final[str] = info.api_prefix_path_tag
 SUMMARY: Final[str] = info.get_summary()
-APP_NAME: Final[str] = __name__.split(".")[0]
+APP_NAME: Final[str] = info.app_name
 
 ## https://patorjk.com/software/taag/#p=display&f=Standard&t=Storage
 APP_STARTED_BANNER_MSG = r"""
diff --git a/services/web/server/src/simcore_service_webserver/_meta.py b/services/web/server/src/simcore_service_webserver/_meta.py
@@ -1,6 +1,5 @@
-""" Current version of the simcore_service_webserver application and its API
+"""Current version of the simcore_service_webserver application and its API"""
 
-"""
 from typing import Final
 
 from models_library.basic_types import VersionStr
@@ -19,7 +18,8 @@
 
 
 # legacy consts
-APP_NAME: str = __name__.split(".")[0]
+APP_NAME: Final[str] = info.app_name
+PROMETHEUS_FRIENDLY_APP_NAME: Final[str] = info.prometheus_friendly_app_name
 api_version_prefix: str = API_VTAG
 
 
diff --git a/services/web/server/src/simcore_service_webserver/diagnostics/_monitoring.py b/services/web/server/src/simcore_service_webserver/diagnostics/_monitoring.py
@@ -55,7 +55,7 @@ def setup_monitoring(app: web.Application):
     )
 
     monitor_services.add_instrumentation(
-        app, get_collector_registry(app), _meta.APP_NAME
+        app, get_collector_registry(app), _meta.PROMETHEUS_FRIENDLY_APP_NAME
     )
 
     # on-the fly stats
diff --git a/services/web/server/tests/unit/isolated/test_diagnostics_healthcheck.py b/services/web/server/tests/unit/isolated/test_diagnostics_healthcheck.py
@@ -173,7 +173,7 @@ async def delay_response(request: web.Request):
 def test_diagnostics_setup(client: TestClient):
     assert client.app
     assert {m.__middleware_name__ for m in client.app.middlewares} == {
-        "servicelib.aiohttp.monitoring.monitor_simcore_service_webserver",
+        "servicelib.aiohttp.monitoring.monitor_simcore-service-webserver",
         "servicelib.aiohttp.rest_middlewares.envelope_v0",
         "servicelib.aiohttp.rest_middlewares.error_v0",
         "simcore_service_webserver.session.plugin.session",
@@ -188,7 +188,7 @@ async def test_healthy_app(client: TestClient, api_version_prefix: str):
     assert data
     assert not error
 
-    assert data["name"] == "simcore_service_webserver"
+    assert data["name"] == simcore_service_webserver._meta.APP_NAME
     assert data["version"] == simcore_service_webserver._meta.__version__
 
 
