fix: update model field access to use class reference in serialization and settings

Author: pcrespov

packages/common-library/src/common_library/serialization.py

@@ -11,7 +11,9 @@ def model_dump_with_secrets(
 ) -> dict[str, Any]:
     data = settings_obj.model_dump(**pydantic_export_options)
 
-    for field_name in settings_obj.model_fields:
+    settings_cls = settings_obj.__class__
+
+    for field_name in settings_cls.model_fields:
         if field_name not in data:
             continue
 
@@ -29,7 +31,9 @@ def model_dump_with_secrets(
             data[field_name] = str(field_data)
 
         elif isinstance(field_data, dict):
-            possible_pydantic_model = settings_obj.model_fields[field_name].annotation
+            possible_pydantic_model = settings_obj.__class__.model_fields[
+                field_name
+            ].annotation
             # NOTE: data could be a dict which does not represent a pydantic model or a union of models
             with contextlib.suppress(AttributeError, ValidationError):
                 data[field_name] = model_dump_with_secrets(

packages/settings-library/src/settings_library/base.py

@@ -120,10 +120,10 @@ def _parse_none(cls, v, info: ValidationInfo):
     model_config = SettingsConfigDict(
         case_sensitive=True,  # All must be capitalized
         env_parse_none_str="null",
-        extra="ignore",
+        extra="ignore",  # NOTE: if "strict" then fields with multiple aliases defined in the envs will fail to validate!
         frozen=True,
         ignored_types=(cached_property,),
-        populate_by_name=True,  # deprecated in pydantic v2.11+
+        populate_by_name=True,  # NOTE: populate_by_name deprecated in pydantic v2.11+
         validate_by_alias=True,
         validate_by_name=True,
         validate_default=True,

packages/settings-library/tests/test__pydantic_settings.py

@@ -12,25 +12,19 @@
 
 """
 
-from collections.abc import Callable
-from typing import Annotated, Any
+from typing import Annotated
 
 import pytest
 from common_library.basic_types import LogLevel
 from common_library.pydantic_fields_extension import is_nullable
 from pydantic import (
     AliasChoices,
-    AmqpDsn,
-    BaseModel,
     Field,
-    ImportString,
-    PostgresDsn,
-    RedisDsn,
     ValidationInfo,
     field_validator,
 )
 from pydantic_core import PydanticUndefined
-from pydantic_settings import BaseSettings, SettingsConfigDict
+from pydantic_settings import BaseSettings
 from pytest_simcore.helpers.monkeypatch_envs import setenvs_from_dict
 from settings_library.application import BaseApplicationSettings
 
@@ -209,46 +203,3 @@ def test_pydantic_serialization_user_warning(monkeypatch: pytest.MonkeyPatch):
     settings = _TestSettings.create_from_envs()
     assert settings.APP_LOGLEVEL == LogLevel.DEBUG
     assert settings.model_dump_json(indent=2)
-
-
-def test_it():
-    class SubModel(BaseModel):
-        foo: str = "bar"
-        apple: int = 1
-
-    class Settings(BaseSettings):
-        auth_key: str = Field(validation_alias="my_auth_key")
-
-        api_key: str = Field(alias="my_api_key")
-
-        redis_dsn: RedisDsn = Field(
-            "redis://user:pass@localhost:6379/1",
-            validation_alias=AliasChoices("service_redis_dsn", "redis_url"),
-        )
-        pg_dsn: PostgresDsn = "postgres://user:pass@localhost:5432/foobar"
-        amqp_dsn: AmqpDsn = "amqp://user:pass@localhost:5672/"
-
-        special_function: ImportString[Callable[[Any], Any]] = "math.cos"
-
-        # to override domains:
-        # export my_prefix_domains='["foo.com", "bar.com"]'
-        domains: set[str] = set()
-
-        # to override more_settings:
-        # export my_prefix_more_settings='{"foo": "x", "apple": 1}'
-        more_settings: SubModel = SubModel()
-
-        model_config = SettingsConfigDict(env_prefix="my_prefix_")
-
-    import math
-
-    assert Settings().model_dump() == {
-        "auth_key": "xxx",
-        "api_key": "xxx",
-        "redis_dsn": RedisDsn("redis://user:pass@localhost:6379/1"),
-        "pg_dsn": PostgresDsn("postgres://user:pass@localhost:5432/foobar"),
-        "amqp_dsn": AmqpDsn("amqp://user:pass@localhost:5672/"),
-        "special_function": math.cos,
-        "domains": set(),
-        "more_settings": {"foo": "bar", "apple": 1},
-    }

packages/settings-library/tests/test_base_w_postgres.py

@@ -62,7 +62,9 @@ class _FakePostgresSettings(BaseCustomSettings):
                 str | None,
                 Field(
                     validation_alias=AliasChoices(
-                        "HOST", "HOSTNAME", "POSTGRES_CLIENT_NAME"
+                        "POSTGRES_CLIENT_NAME",
+                        "HOST",
+                        "HOSTNAME",
                     ),
                 ),
             ] = None

services/api-server/src/simcore_service_api_server/core/settings.py

@@ -34,7 +34,9 @@ class WebServerSettings(WebServerBaseSettings, MixinSessionSettings):
             description="Secret key to encrypt cookies. "
             'TIP: python3 -c "from cryptography.fernet import *; print(Fernet.generate_key())"',
             min_length=44,
-            validation_alias=AliasChoices("SESSION_SECRET_KEY"),
+            validation_alias=AliasChoices(
+                "WEBSERVER_SESSION_SECRET_KEY", "SESSION_SECRET_KEY"
+            ),
         ),
     ]
     WEBSERVER_SESSION_NAME: str = DEFAULT_SESSION_COOKIE_NAME