moved logic to webserver

Author: pcrespov

api/specs/web-server/_users.py

@@ -10,8 +10,6 @@
 from models_library.api_schemas_webserver.users import (
     MyFunctionPermissionsGet,
     MyPermissionGet,
-    MyPhoneConfirm,
-    MyPhoneRegister,
     MyProfileRestGet,
     MyProfileRestPatch,
     MyTokenCreate,
@@ -32,6 +30,10 @@
     UserNotificationCreate,
     UserNotificationPatch,
 )
+from simcore_service_webserver.users._controller.rest._rest_schemas import (
+    MyPhoneConfirm,
+    MyPhoneRegister,
+)
 
 router = APIRouter(prefix=f"/{API_VTAG}", tags=["users"])
 

packages/models-library/requirements/_base.in

@@ -7,7 +7,6 @@
 arrow
 jsonschema
 orjson
-phonenumbers
 pydantic-extra-types
 pydantic-settings
 pydantic[email]

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

@@ -1,7 +1,7 @@
 import re
 from datetime import date, datetime
 from enum import Enum
-from typing import Annotated, Any, Literal, Self, TypeAlias
+from typing import Annotated, Any, Literal, Self
 
 import annotated_types
 from common_library.basic_types import DEFAULT_FACTORY
@@ -20,7 +20,6 @@
     field_validator,
 )
 from pydantic.config import JsonDict
-from pydantic_extra_types.phone_numbers import PhoneNumberValidator
 
 from ..basic_types import IDStr
 from ..emails import LowerCaseEmailStr
@@ -208,29 +207,6 @@ def _validate_user_name(cls, value: str):
         return value
 
 
-#
-# PHONE REGISTRATION
-#
-
-
-PhoneNumberStr: TypeAlias = Annotated[str, PhoneNumberValidator(number_format="E164")]
-
-
-class MyPhoneRegister(InputSchema):
-    phone: Annotated[
-        PhoneNumberStr,
-        Field(description="Phone number to register"),
-    ]
-
-
-class MyPhoneConfirm(InputSchema):
-    code: Annotated[
-        str,
-        StringConstraints(strip_whitespace=True, pattern=r"^[A-Za-z0-9]+$"),
-        Field(description="Alphanumeric confirmation code"),
-    ]
-
-
 #
 # USER
 #

packages/models-library/tests/test_users.py

@@ -1,13 +1,10 @@
-import pytest
 from models_library.api_schemas_webserver.users import (
-    MyPhoneRegister,
     MyProfileRestGet,
-    PhoneNumberStr,
 )
 from models_library.api_schemas_webserver.users_preferences import Preference
 from models_library.groups import AccessRightsDict, Group, GroupsByTypeTuple
 from models_library.users import MyProfile
-from pydantic import TypeAdapter, ValidationError
+from pydantic import TypeAdapter
 
 
 def test_adapter_from_model_to_schema():
@@ -30,38 +27,3 @@ def test_adapter_from_model_to_schema():
     MyProfileRestGet.from_domain_model(
         my_profile, my_groups_by_type, my_product_group, my_preferences
     )
-
-
-@pytest.mark.parametrize(
-    "phone",
-    ["+41763456789", "+19104630364", "+1 301-304-4567"],
-)
-def test_valid_phone_numbers(phone: str):
-    # This test is used to tune options of PhoneNumberValidator
-    assert MyPhoneRegister.model_validate({"phone": phone}).phone == TypeAdapter(
-        PhoneNumberStr
-    ).validate_python(phone)
-
-
-@pytest.mark.parametrize(
-    "phone",
-    [
-        "+41763456789",
-        "+41 76 345 67 89",
-        "tel:+41-76-345-67-89",
-    ],
-    ids=["E.164", "INTERNATIONAL", "RFC3966"],
-)
-def test_autoformat_phone_number_to_e164(phone: str):
-    # This test is used to tune options of PhoneNumberValidator formatting to E164
-    assert TypeAdapter(PhoneNumberStr).validate_python(phone) == "+41763456789"
-
-
-@pytest.mark.parametrize(
-    "phone",
-    ["41763456789", "+09104630364", "+1 111-304-4567"],
-)
-def test_invalid_phone_numbers(phone: str):
-    # This test is used to tune options of PhoneNumberValidator
-    with pytest.raises(ValidationError):
-        MyPhoneRegister.model_validate({"phone": phone})

services/web/server/src/simcore_service_webserver/users/_controller/rest/_rest_schemas.py

@@ -7,26 +7,64 @@
 import re
 import sys
 from contextlib import suppress
-from typing import Annotated, Any, Final
+from typing import Annotated, Any, Final, TypeAlias
 
 import pycountry
 from common_library.basic_types import DEFAULT_FACTORY
 from models_library.api_schemas_webserver._base import InputSchema
-from models_library.api_schemas_webserver.users import PhoneNumberStr, UserAccountGet
+from models_library.api_schemas_webserver.users import UserAccountGet
 from models_library.emails import LowerCaseEmailStr
-from pydantic import ConfigDict, Field, field_validator, model_validator
+from pydantic import (
+    ConfigDict,
+    Field,
+    StringConstraints,
+    field_validator,
+    model_validator,
+)
+from pydantic_extra_types.phone_numbers import PhoneNumberValidator
 
 from ....models import AuthenticatedRequestContext
 
+MAX_BYTES_SIZE_EXTRAS: Final[int] = 512
+
 
 class UsersRequestContext(AuthenticatedRequestContext): ...
 
 
-MAX_BYTES_SIZE_EXTRAS: Final[int] = 512
+#
+# PHONE REGISTRATION
+#
+
+
+PhoneNumberStr: TypeAlias = Annotated[
+    # NOTE: validator require installing `phonenumbers``
+    str,
+    PhoneNumberValidator(number_format="E164"),
+]
+
+
+class MyPhoneRegister(InputSchema):
+    phone: Annotated[
+        PhoneNumberStr,
+        Field(description="Phone number to register"),
+    ]
+
+
+class MyPhoneConfirm(InputSchema):
+    code: Annotated[
+        str,
+        StringConstraints(strip_whitespace=True, pattern=r"^[A-Za-z0-9]+$"),
+        Field(description="Alphanumeric confirmation code"),
+    ]
+
+
+#
+# USER-ACCCOUNT
+#
 
 
 class UserAccountRestPreRegister(InputSchema):
-    # NOTE: validators need pycountry!
+    # NOTE: validators require installing `pycountry`
 
     first_name: str
     last_name: str

services/web/server/src/simcore_service_webserver/users/_controller/rest/users_rest.py

@@ -3,8 +3,6 @@
 
 from aiohttp import web
 from models_library.api_schemas_webserver.users import (
-    MyPhoneConfirm,
-    MyPhoneRegister,
     MyProfileRestGet,
     MyProfileRestPatch,
     UserGet,
@@ -30,7 +28,7 @@
 from ... import _users_service
 from ..._users_web import RegistrationSessionManager
 from ._rest_exceptions import handle_rest_requests_exceptions
-from ._rest_schemas import UsersRequestContext
+from ._rest_schemas import MyPhoneConfirm, MyPhoneRegister, UsersRequestContext
 
 _logger = logging.getLogger(__name__)
 

services/web/server/tests/unit/isolated/test_users_models.py

@@ -16,8 +16,13 @@
 )
 from models_library.generics import Envelope
 from models_library.utils.fastapi_encoders import jsonable_encoder
+from pydantic import TypeAdapter, ValidationError
 from servicelib.rest_constants import RESPONSE_MODEL_POLICY
 from simcore_postgres_database import utils_users
+from simcore_service_webserver.users._controller.rest._rest_schemas import (
+    MyPhoneRegister,
+    PhoneNumberStr,
+)
 from simcore_service_webserver.users._models import UserModelAdapter
 
 
@@ -150,3 +155,38 @@ def test_utils_user_generates_valid_myprofile_patch():
     MyProfileRestPatch.model_validate(
         {"userName": utils_users.generate_alternative_username(username)}
     )
+
+
+@pytest.mark.parametrize(
+    "phone",
+    ["+41763456789", "+19104630364", "+1 301-304-4567"],
+)
+def test_valid_phone_numbers(phone: str):
+    # This test is used to tune options of PhoneNumberValidator
+    assert MyPhoneRegister.model_validate({"phone": phone}).phone == TypeAdapter(
+        PhoneNumberStr
+    ).validate_python(phone)
+
+
+@pytest.mark.parametrize(
+    "phone",
+    [
+        "+41763456789",
+        "+41 76 345 67 89",
+        "tel:+41-76-345-67-89",
+    ],
+    ids=["E.164", "INTERNATIONAL", "RFC3966"],
+)
+def test_autoformat_phone_number_to_e164(phone: str):
+    # This test is used to tune options of PhoneNumberValidator formatting to E164
+    assert TypeAdapter(PhoneNumberStr).validate_python(phone) == "+41763456789"
+
+
+@pytest.mark.parametrize(
+    "phone",
+    ["41763456789", "+09104630364", "+1 111-304-4567"],
+)
+def test_invalid_phone_numbers(phone: str):
+    # This test is used to tune options of PhoneNumberValidator
+    with pytest.raises(ValidationError):
+        MyPhoneRegister.model_validate({"phone": phone})