moves users

Author: pcrespov

api/specs/web-server/_users.py

@@ -10,7 +10,6 @@
 from models_library.api_schemas_webserver.users import (
     MyProfileGet,
     MyProfilePatch,
-    PreRegisteredUserGet,
     SearchQueryParams,
     UserGet,
 )
@@ -26,6 +25,7 @@
 from simcore_service_webserver.users._notifications_handlers import (
     _NotificationPathParams,
 )
+from simcore_service_webserver.users._schemas import PreRegisteredUserGet
 from simcore_service_webserver.users._tokens_handlers import _TokenPathParams
 from simcore_service_webserver.users.schemas import (
     PermissionGet,

packages/models-library/src/models_library/api_schemas_webserver/groups.py

@@ -2,7 +2,6 @@
 from typing import Annotated, Any, Self, TypeVar
 
 from common_library.basic_types import DEFAULT_FACTORY
-from models_library.groups import EVERYONE_GROUP_ID
 from pydantic import (
     AnyHttpUrl,
     AnyUrl,
@@ -17,6 +16,7 @@
 
 from ..emails import LowerCaseEmailStr
 from ..groups import (
+    EVERYONE_GROUP_ID,
     AccessRightsDict,
     Group,
     GroupID,

packages/models-library/src/models_library/api_schemas_webserver/users.py

@@ -1,29 +1,18 @@
 import re
-import sys
-from contextlib import suppress
 from datetime import date
 from enum import Enum
-from typing import Annotated, Any, Final, Literal
+from typing import Annotated, Any, Literal
 
-import pycountry
-from models_library.api_schemas_webserver._base import InputSchema, OutputSchema
-from models_library.api_schemas_webserver.groups import MyGroupsGet
-from models_library.api_schemas_webserver.users_preferences import AggregatedPreferences
-from models_library.basic_types import IDStr
-from models_library.emails import LowerCaseEmailStr
-from models_library.products import ProductName
-from models_library.users import FirstNameStr, LastNameStr, UserID
-from pydantic import (
-    BaseModel,
-    ConfigDict,
-    Field,
-    ValidationInfo,
-    field_validator,
-    model_validator,
-)
-from simcore_postgres_database.models.users import UserStatus
+from common_library.users_enums import UserStatus
+from pydantic import BaseModel, ConfigDict, Field, ValidationInfo, field_validator
 
+from ..basic_types import IDStr
+from ..emails import LowerCaseEmailStr
+from ..products import ProductName
+from ..users import FirstNameStr, LastNameStr, UserID
 from ._base import InputSchema, OutputSchema
+from .groups import MyGroupsGet
+from .users_preferences import AggregatedPreferences
 
 
 class MyProfilePrivacyGet(OutputSchema):
@@ -187,86 +176,3 @@ def _consistency_check(cls, v, info: ValidationInfo):
             msg = f"{registered=} and {status=} is not allowed"
             raise ValueError(msg)
         return v
-
-
-MAX_BYTES_SIZE_EXTRAS: Final[int] = 512
-
-
-class PreRegisteredUserGet(InputSchema):
-    first_name: str
-    last_name: str
-    email: LowerCaseEmailStr
-    institution: str | None = Field(
-        default=None, description="company, university, ..."
-    )
-    phone: str | None
-    # billing details
-    address: str
-    city: str
-    state: str | None = Field(default=None)
-    postal_code: str
-    country: str
-    extras: Annotated[
-        dict[str, Any],
-        Field(
-            default_factory=dict,
-            description="Keeps extra information provided in the request form. At most MAX_NUM_EXTRAS fields",
-        ),
-    ]
-
-    model_config = ConfigDict(str_strip_whitespace=True, str_max_length=200)
-
-    @model_validator(mode="before")
-    @classmethod
-    def _preprocess_aliases_and_extras(cls, values):
-        # multiple aliases for "institution"
-        alias_by_priority = ("companyName", "company", "university", "universityName")
-        if "institution" not in values:
-
-            for alias in alias_by_priority:
-                if alias in values:
-                    values["institution"] = values.pop(alias)
-
-        # collect extras
-        extra_fields = {}
-        field_names_and_aliases = (
-            set(cls.model_fields.keys())
-            | {f.alias for f in cls.model_fields.values() if f.alias}
-            | set(alias_by_priority)
-        )
-        for key, value in values.items():
-            if key not in field_names_and_aliases:
-                extra_fields[key] = value
-                if sys.getsizeof(extra_fields) > MAX_BYTES_SIZE_EXTRAS:
-                    extra_fields.pop(key)
-                    break
-
-        for key in extra_fields:
-            values.pop(key)
-
-        values.setdefault("extras", {})
-        values["extras"].update(extra_fields)
-
-        return values
-
-    @field_validator("first_name", "last_name", "institution", mode="before")
-    @classmethod
-    def _pre_normalize_given_names(cls, v):
-        if v:
-            with suppress(Exception):  # skip if funny characters
-                name = re.sub(r"\s+", " ", v)
-                return re.sub(r"\b\w+\b", lambda m: m.group(0).capitalize(), name)
-        return v
-
-    @field_validator("country", mode="before")
-    @classmethod
-    def _pre_check_and_normalize_country(cls, v):
-        if v:
-            try:
-                return pycountry.countries.lookup(v).name
-            except LookupError as err:
-                raise ValueError(v) from err
-        return v
-
-
-assert set(PreRegisteredUserGet.model_fields).issubset(UserGet.model_fields)  # nosec

services/web/server/src/simcore_service_webserver/users/_schemas.py

@@ -1,10 +1,20 @@
-""" models for rest api schemas, i.e. those defined in openapi.json
+""" input/output datasets used in the rest-API
 
+NOTE: Most of the model schemas are in `models_library.api_schemas_webserver.users`, the rest (hidden or needs a dependency) is here
 """
 
 
+import re
+import sys
+from contextlib import suppress
+from typing import Annotated, Any, Final
+
+import pycountry
+from models_library.api_schemas_webserver._base import InputSchema
+from models_library.api_schemas_webserver.users import UserGet
+from models_library.emails import LowerCaseEmailStr
 from models_library.users import UserID
-from pydantic import BaseModel, Field
+from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
 from servicelib.request_keys import RQT_USERID_KEY
 
 from .._constants import RQ_PRODUCT_KEY
@@ -13,3 +23,89 @@
 class UsersRequestContext(BaseModel):
     user_id: UserID = Field(..., alias=RQT_USERID_KEY)  # type: ignore[literal-required]
     product_name: str = Field(..., alias=RQ_PRODUCT_KEY)  # type: ignore[literal-required]
+
+
+MAX_BYTES_SIZE_EXTRAS: Final[int] = 512
+
+
+class PreRegisteredUserGet(InputSchema):
+    # NOTE: validators need pycountry!
+
+    first_name: str
+    last_name: str
+    email: LowerCaseEmailStr
+    institution: str | None = Field(
+        default=None, description="company, university, ..."
+    )
+    phone: str | None
+    # billing details
+    address: str
+    city: str
+    state: str | None = Field(default=None)
+    postal_code: str
+    country: str
+    extras: Annotated[
+        dict[str, Any],
+        Field(
+            default_factory=dict,
+            description="Keeps extra information provided in the request form. At most MAX_NUM_EXTRAS fields",
+        ),
+    ]
+
+    model_config = ConfigDict(str_strip_whitespace=True, str_max_length=200)
+
+    @model_validator(mode="before")
+    @classmethod
+    def _preprocess_aliases_and_extras(cls, values):
+        # multiple aliases for "institution"
+        alias_by_priority = ("companyName", "company", "university", "universityName")
+        if "institution" not in values:
+
+            for alias in alias_by_priority:
+                if alias in values:
+                    values["institution"] = values.pop(alias)
+
+        # collect extras
+        extra_fields = {}
+        field_names_and_aliases = (
+            set(cls.model_fields.keys())
+            | {f.alias for f in cls.model_fields.values() if f.alias}
+            | set(alias_by_priority)
+        )
+        for key, value in values.items():
+            if key not in field_names_and_aliases:
+                extra_fields[key] = value
+                if sys.getsizeof(extra_fields) > MAX_BYTES_SIZE_EXTRAS:
+                    extra_fields.pop(key)
+                    break
+
+        for key in extra_fields:
+            values.pop(key)
+
+        values.setdefault("extras", {})
+        values["extras"].update(extra_fields)
+
+        return values
+
+    @field_validator("first_name", "last_name", "institution", mode="before")
+    @classmethod
+    def _pre_normalize_given_names(cls, v):
+        if v:
+            with suppress(Exception):  # skip if funny characters
+                name = re.sub(r"\s+", " ", v)
+                return re.sub(r"\b\w+\b", lambda m: m.group(0).capitalize(), name)
+        return v
+
+    @field_validator("country", mode="before")
+    @classmethod
+    def _pre_check_and_normalize_country(cls, v):
+        if v:
+            try:
+                return pycountry.countries.lookup(v).name
+            except LookupError as err:
+                raise ValueError(v) from err
+        return v
+
+
+# asserts field names are in sync
+assert set(PreRegisteredUserGet.model_fields).issubset(UserGet.model_fields)  # nosec

services/web/server/src/simcore_service_webserver/users/_users_rest.py

@@ -5,7 +5,6 @@
 from models_library.api_schemas_webserver.users import (
     MyProfileGet,
     MyProfilePatch,
-    PreRegisteredUserGet,
     SearchQueryParams,
 )
 from servicelib.aiohttp import status
@@ -23,7 +22,7 @@
 from ..utils_aiohttp import envelope_json_response
 from . import _users_service, api
 from ._constants import FMSG_MISSING_CONFIG_WITH_OEC
-from ._schemas import UsersRequestContext
+from ._schemas import PreRegisteredUserGet, UsersRequestContext
 from .exceptions import (
     AlreadyPreRegisteredError,
     MissingGroupExtraPropertiesForProductError,

services/web/server/tests/unit/with_dbs/03/test_users.py

@@ -18,12 +18,7 @@
 from aiopg.sa.connection import SAConnection
 from faker import Faker
 from models_library.api_schemas_webserver.auth import AccountRequestInfo
-from models_library.api_schemas_webserver.users import (
-    MAX_BYTES_SIZE_EXTRAS,
-    MyProfileGet,
-    PreRegisteredUserGet,
-    UserGet,
-)
+from models_library.api_schemas_webserver.users import MyProfileGet, UserGet
 from models_library.generics import Envelope
 from psycopg2 import OperationalError
 from pytest_simcore.helpers.assert_checks import assert_status
@@ -39,6 +34,10 @@
 from simcore_service_webserver.users._preferences_api import (
     get_frontend_user_preferences_aggregation,
 )
+from simcore_service_webserver.users._schemas import (
+    MAX_BYTES_SIZE_EXTRAS,
+    PreRegisteredUserGet,
+)
 
 
 @pytest.fixture