Refactor application setup to remove APP_SETTINGS_KEY and use app_settings_key parameter

Author: pcrespov

packages/service-library/src/servicelib/aiohttp/application_setup.py

@@ -16,7 +16,7 @@
     TypedDict,
 )
 
-from .application_keys import APP_CONFIG_KEY, APP_SETTINGS_KEY
+from .application_keys import APP_CONFIG_KEY
 
 _logger = logging.getLogger(__name__)
 
@@ -115,13 +115,14 @@ def _get_app_settings_and_field_name(
     arg_settings_name: str | None,
     setup_func_name: str,
     logger: logging.Logger,
+    app_settings_key: web.AppKey,
 ) -> tuple[_ApplicationSettings | None, str | None]:
-    app_settings: _ApplicationSettings | None = app.get(APP_SETTINGS_KEY)
+    app_settings: _ApplicationSettings | None = app.get(app_settings_key)
     settings_field_name = arg_settings_name
 
     if app_settings:
         if not settings_field_name:
-            # FIXME: hard-coded WEBSERVER_ temporary
+            # NOTE: hard-coded WEBSERVER_ temporary
             settings_field_name = f"WEBSERVER_{arg_module_name.split('.')[-1].upper()}"
 
         logger.debug("Checking addon's %s ", f"{settings_field_name=}")
@@ -246,6 +247,7 @@ def app_module_setup(
     module_name: str,
     category: ModuleCategory,
     *,
+    app_settings_key: web.AppKey,
     settings_name: str | None = None,
     depends: list[str] | None = None,
     logger: logging.Logger = _logger,
@@ -336,6 +338,7 @@ def _wrapper(app: web.Application, *args, **kargs) -> bool:
                     settings_name,
                     setup_func.__name__,
                     logger,
+                    app_settings_key,
                 )
 
                 if (

packages/service-library/tests/aiohttp/test_application_setup.py

@@ -36,18 +36,26 @@ def app_config() -> dict:
     }
 
 
+@pytest.fixture
+def app_settings_key() -> web.AppKey:
+    return web.AppKey("test_app_settings", object)
+
+
 @pytest.fixture
 def app(app_config: dict) -> web.Application:
     _app = web.Application()
     _app[APP_CONFIG_KEY] = app_config
     return _app
 
 
-def test_setup_config_enabled(app_config: dict, app: web.Application):
+def test_setup_config_enabled(
+    app_config: dict, app: web.Application, app_settings_key: web.AppKey
+):
 
     @app_module_setup(
         "package.zee",
         ModuleCategory.ADDON,
+        app_settings_key=app_settings_key,
         # legacy support for config_enabled
         config_enabled="main.zee_enabled",
     )
@@ -63,15 +71,18 @@ def setup_zee(app: web.Application, arg) -> bool:
     assert not setup_zee(app, 2)
 
 
-def test_setup_dependencies(app: web.Application):
+def test_setup_dependencies(app: web.Application, app_settings_key: web.AppKey):
 
-    @app_module_setup("package.foo", ModuleCategory.ADDON)
+    @app_module_setup(
+        "package.foo", ModuleCategory.ADDON, app_settings_key=app_settings_key
+    )
     def setup_foo(app: web.Application) -> bool:
         return True
 
     @app_module_setup(
         "package.needs_foo",
         ModuleCategory.SYSTEM,
+        app_settings_key=app_settings_key,
         depends=[
             # This module needs foo to be setup first
             "package.foo",
@@ -94,8 +105,12 @@ def setup_needs_foo(app: web.Application) -> bool:
     ]
 
 
-def test_marked_setup(app_config: dict, app: web.Application):
-    @app_module_setup("package.foo", ModuleCategory.ADDON)
+def test_marked_setup(
+    app_config: dict, app: web.Application, app_settings_key: web.AppKey
+):
+    @app_module_setup(
+        "package.foo", ModuleCategory.ADDON, app_settings_key=app_settings_key
+    )
     def setup_foo(app: web.Application) -> bool:
         return True
 
@@ -107,8 +122,15 @@ def setup_foo(app: web.Application) -> bool:
     assert not setup_foo(app)
 
 
-def test_skip_setup(app: web.Application, mock_logger: MockType):
-    @app_module_setup("package.foo", ModuleCategory.ADDON, logger=mock_logger)
+def test_skip_setup(
+    app: web.Application, mock_logger: MockType, app_settings_key: web.AppKey
+):
+    @app_module_setup(
+        "package.foo",
+        ModuleCategory.ADDON,
+        app_settings_key=app_settings_key,
+        logger=mock_logger,
+    )
     def setup_foo(app: web.Application, *, raise_skip: bool = False) -> bool:
         if raise_skip:
             raise SkipModuleSetupError(reason="explicit skip")

services/web/server/src/simcore_service_webserver/application_setup.py

@@ -0,0 +1,17 @@
+import functools
+
+import servicelib.aiohttp.application_setup
+
+from .constants import APP_SETTINGS_KEY
+
+ensure_single_setup = servicelib.aiohttp.application_setup.ensure_single_setup
+app_setup_func = functools.partial(
+    servicelib.aiohttp.application_setup.app_module_setup,
+    app_settings_key=APP_SETTINGS_KEY,
+)
+
+
+__all__: tuple[str, ...] = (
+    "app_setup_func",
+    "ensure_single_setup",
+)