🐛 is3372/fixes warning of alias in BaseSettings (ITISFoundation#3454)

Author: pcrespov

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

@@ -215,18 +215,6 @@ def enable_only_if_dev_features_allowed(cls, v, values, field: ModelField):
             log.warning("%s still under development and will be disabled.", field.name)
         return None if field.allow_none else False
 
-    class Config(BaseCustomSettings.Config):
-        # NOTE: FutureWarning: aliases are no longer used by BaseSettings to define which environment variables to read.
-        #       Instead use the "env" field setting. See https://pydantic-docs.helpmanual.io/usage/settings/#environment-variable-names
-        # NOTE: These alias are ONLY used in export, not in constructor
-        fields = {
-            "SC_VCS_URL": "vcs_url",
-            "SC_VCS_REF": "vcs_ref",
-            "SC_BUILD_DATE": "build_date",
-            "SWARM_STACK_NAME": "stack_name",
-        }
-        alias_generator = lambda s: s.lower()
-
     @cached_property
     def log_level(self) -> int:
         return getattr(logging, self.WEBSERVER_LOGLEVEL.upper())
@@ -273,6 +261,31 @@ def _get_disabled_public_plugins(self) -> list[str]:
                 plugins_disabled.append(field_name)
         return plugins_disabled
 
+    def _export_by_alias(self, **kwargs) -> dict[str, Any]:
+        #  This is a small helper to assist export functions since aliases are no longer used by
+        #  BaseSettings to define which environment variables to read.
+        #  SEE https://github.com/ITISFoundation/osparc-simcore/issues/3372
+        #
+        # NOTE: This is a copy from pydantic's Config.fields and Config.alias_generator
+        # SEE https://pydantic-docs.helpmanual.io/usage/model_config/#options
+        # SEE https://pydantic-docs.helpmanual.io/usage/model_config/#alias-generator
+        #
+        config_fields = {
+            "SC_VCS_URL": "vcs_url",
+            "SC_VCS_REF": "vcs_ref",
+            "SC_BUILD_DATE": "build_date",
+            "SWARM_STACK_NAME": "stack_name",
+        }
+        config_alias_generator = lambda s: s.lower()
+
+        data = self.dict(**kwargs)
+        current_keys = list(data.keys())
+
+        for key in current_keys:
+            if new_key := (config_fields.get(key) or config_alias_generator(key)):
+                data[new_key] = data.pop(key)
+        return data
+
     def public_dict(self) -> dict[str, Any]:
         """Data publicaly available"""
 
@@ -284,7 +297,7 @@ def public_dict(self) -> dict[str, Any]:
             data["login_2fa_required"] = self.WEBSERVER_LOGIN.LOGIN_2FA_REQUIRED
 
         data.update(
-            self.dict(
+            self._export_by_alias(
                 include={
                     "APP_NAME",
                     "API_VERSION",
@@ -293,13 +306,12 @@ def public_dict(self) -> dict[str, Any]:
                     "SC_BUILD_DATE",
                 },
                 exclude_none=True,
-                by_alias=True,
             )
         )
         return data
 
     def to_client_statics(self) -> dict[str, Any]:
-        data = self.dict(
+        data = self._export_by_alias(
             include={
                 "APP_NAME",
                 "API_VERSION",
@@ -309,7 +321,6 @@ def to_client_statics(self) -> dict[str, Any]:
                 "SWARM_STACK_NAME",
             },
             exclude_none=True,
-            by_alias=True,
         )
         data["plugins_disabled"] = self._get_disabled_public_plugins()
 

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

@@ -13,18 +13,14 @@
 
 """
 
-
 import logging
 import os
 
 import typer
 from aiohttp import web
 from settings_library.utils_cli import create_settings_command
 
-from .application import create_application, run_service
 from .application_settings import ApplicationSettings
-from .application_settings_utils import convert_to_app_config
-from .log import setup_logging
 from .login import cli as login_cli
 
 # ptsvd cause issues with ProcessPoolExecutor
@@ -40,8 +36,12 @@
 def _setup_app_from_settings(
     settings: ApplicationSettings,
 ) -> tuple[web.Application, dict]:
+    # NOTE: keeping imports here to reduce CLI load time
+    from .application import create_application
+    from .application_settings_utils import convert_to_app_config
+    from .log import setup_logging
 
-    # NOTE: keeping an equivalent config allows us
+    # NOTE: By having an equivalent config allows us
     # to keep some of the code from the previous
     # design whose starting point was a validated
     # config. E.g. many test fixtures were based on
@@ -60,7 +60,7 @@ def _setup_app_from_settings(
 
 async def app_factory() -> web.Application:
     """Created to launch app from gunicorn (see docker/boot.sh)"""
-    app_settings = ApplicationSettings()
+    app_settings = ApplicationSettings.create_from_envs()
     assert app_settings.SC_BUILD_TARGET  # nosec
 
     log.info("Application settings: %s", app_settings.json(indent=2, sort_keys=True))
@@ -82,6 +82,9 @@ async def app_factory() -> web.Application:
 @main.command()
 def run():
     """Runs web server"""
-    app_settings = ApplicationSettings()
+    # NOTE: keeping imports here to reduce CLI load time
+    from .application import run_service
+
+    app_settings = ApplicationSettings.create_from_envs()
     app, cfg = _setup_app_from_settings(app_settings)
     run_service(app, cfg)