✨ Enhance Account Request Flow with Pre-Registration and PO Approval Handling (#8026)

Author: pcrespov

api/specs/web-server/_users_admin.py

@@ -19,7 +19,7 @@
 from models_library.generics import Envelope
 from models_library.rest_pagination import Page
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.users._common.schemas import PreRegisteredUserGet
+from simcore_service_webserver.users.schemas import PreRegisteredUserGet
 
 router = APIRouter(prefix=f"/{API_VTAG}", tags=["users"])
 

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

@@ -300,8 +300,9 @@ class UserAccountGet(OutputSchema):
         ),
     ] = DEFAULT_FACTORY
 
-    # pre-registration
+    # pre-registration NOTE: that some users have no pre-registartion and therefore all options here can be none
     pre_registration_id: int | None
+    pre_registration_created: datetime | None
     invited_by: str | None = None
     account_request_status: AccountRequestStatus | None
     account_request_reviewed_by: UserID | None = None

services/web/server/VERSION

@@ -1 +1 @@
-0.69.1
+0.70.0

services/web/server/setup.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.69.1
+current_version = 0.70.0
 commit = True
 message = services/webserver api version: {current_version} → {new_version}
 tag = False

services/web/server/src/simcore_service_webserver/api/v0/openapi.yaml

@@ -2,7 +2,7 @@ openapi: 3.1.0
 info:
   title: simcore-service-webserver
   description: Main service with an interface (http-API & websockets) to the web front-end
-  version: 0.69.1
+  version: 0.70.0
 servers:
 - url: ''
   description: webserver
@@ -17166,6 +17166,12 @@ components:
           - type: integer
           - type: 'null'
           title: Preregistrationid
+        preRegistrationCreated:
+          anyOf:
+          - type: string
+            format: date-time
+          - type: 'null'
+          title: Preregistrationcreated
         invitedBy:
           anyOf:
           - type: string
@@ -17217,6 +17223,7 @@ components:
       - postalCode
       - country
       - preRegistrationId
+      - preRegistrationCreated
       - accountRequestStatus
       - registered
       - status

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

@@ -1,6 +1,5 @@
 # pylint:disable=unused-import
 
-from sys import version
 from typing import Final
 
 from common_library.user_messages import user_message

services/web/server/src/simcore_service_webserver/login/_controller/rest/_rest_exceptions.py

@@ -0,0 +1,35 @@
+from common_library.user_messages import user_message
+from servicelib.aiohttp import status
+
+from ....exception_handling import (
+    ExceptionToHttpErrorMap,
+    HttpErrorInfo,
+    exception_handling_decorator,
+    to_exceptions_handlers_map,
+)
+from ....users.exceptions import AlreadyPreRegisteredError
+from ..._constants import MSG_2FA_UNAVAILABLE
+from ...errors import SendingVerificationEmailError, SendingVerificationSmsError
+
+_TO_HTTP_ERROR_MAP: ExceptionToHttpErrorMap = {
+    AlreadyPreRegisteredError: HttpErrorInfo(
+        status.HTTP_409_CONFLICT,
+        user_message(
+            "An account for the email {email} has been submitted. If you haven't received any updates, please contact support.",
+            _version=1,
+        ),
+    ),
+    SendingVerificationSmsError: HttpErrorInfo(
+        status.HTTP_503_SERVICE_UNAVAILABLE,
+        MSG_2FA_UNAVAILABLE,
+    ),
+    SendingVerificationEmailError: HttpErrorInfo(
+        status.HTTP_503_SERVICE_UNAVAILABLE,
+        MSG_2FA_UNAVAILABLE,
+    ),
+}
+
+
+handle_rest_requests_exceptions = exception_handling_decorator(
+    to_exceptions_handlers_map(_TO_HTTP_ERROR_MAP)
+)

services/web/server/src/simcore_service_webserver/login/_controller/rest/auth.py

@@ -39,8 +39,8 @@
 )
 from ..._models import InputSchema
 from ...decorators import login_required
-from ...errors import handle_login_exceptions
 from ...settings import LoginSettingsForProduct, get_plugin_settings
+from ._rest_exceptions import handle_rest_requests_exceptions
 
 log = logging.getLogger(__name__)
 
@@ -75,7 +75,7 @@ class LoginNextPage(NextPage[CodePageParams]): ...
     name="auth_resend_2fa_code",
     max_access_count=MAX_2FA_CODE_RESEND,
 )
-@handle_login_exceptions
+@handle_rest_requests_exceptions
 async def login(request: web.Request):
     """Login: user submits an email (identification) and a password
 
@@ -218,6 +218,7 @@ class LoginTwoFactorAuthBody(InputSchema):
     "auth_login_2fa",
     unauthorized_reason=MSG_UNAUTHORIZED_LOGIN_2FA,
 )
+@handle_rest_requests_exceptions
 async def login_2fa(request: web.Request):
     """Login (continuation): Submits 2FA code"""
     product: Product = products_web.get_current_product(request)
@@ -266,6 +267,7 @@ class LogoutBody(InputSchema):
 
 @routes.post(f"/{API_VTAG}/auth/logout", name="auth_logout")
 @login_required
+@handle_rest_requests_exceptions
 async def logout(request: web.Request) -> web.Response:
     user_id = request.get(RQT_USERID_KEY, -1)
 

services/web/server/src/simcore_service_webserver/login/_controller/rest/change.py

@@ -6,7 +6,6 @@
 from pydantic import SecretStr, field_validator
 from servicelib.aiohttp.requests_validation import parse_request_body_as
 from servicelib.logging_errors import create_troubleshootting_log_kwargs
-from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
 from servicelib.request_keys import RQT_USERID_KEY
 from simcore_postgres_database.utils_repos import pass_or_acquire_connection
 from simcore_postgres_database.utils_users import UsersRepo
@@ -296,9 +295,7 @@ async def change_password(request: web.Request):
     if not security_service.check_password(
         passwords.current.get_secret_value(), user["password_hash"]
     ):
-        raise web.HTTPUnprocessableEntity(
-            text=MSG_WRONG_PASSWORD, content_type=MIMETYPE_APPLICATION_JSON
-        )  # 422
+        raise web.HTTPUnprocessableEntity(text=MSG_WRONG_PASSWORD)  # 422
 
     await db.update_user(
         dict(user),

services/web/server/src/simcore_service_webserver/login/_controller/rest/preregistration.py

@@ -12,7 +12,6 @@
 from servicelib.aiohttp.application_keys import APP_FIRE_AND_FORGET_TASKS_KEY
 from servicelib.aiohttp.requests_validation import parse_request_body_as
 from servicelib.logging_utils import get_log_record_extra, log_context
-from servicelib.mimetype_constants import MIMETYPE_APPLICATION_JSON
 from servicelib.request_keys import RQT_USERID_KEY
 from servicelib.utils import fire_and_forget_task
 
@@ -22,8 +21,9 @@
 from ....products.models import Product
 from ....security import security_service, security_web
 from ....security.decorators import permission_required
-from ....session.api import get_session
-from ....users.api import get_user_credentials, set_user_as_deleted
+from ....session import api as session_service
+from ....users import api as users_service
+from ....users._common.schemas import PreRegisteredUserGet
 from ....utils import MINUTE
 from ....utils_rate_limiting import global_rate_limit_route
 from ... import _preregistration_service
@@ -35,6 +35,7 @@
 from ..._login_service import flash_response, notify_user_logout
 from ...decorators import login_required
 from ...settings import LoginSettingsForProduct, get_plugin_settings
+from ._rest_exceptions import handle_rest_requests_exceptions
 
 _logger = logging.getLogger(__name__)
 
@@ -62,24 +63,30 @@ def _get_ipinfo(request: web.Request) -> dict[str, Any]:
     name="request_product_account",
 )
 @global_rate_limit_route(number_of_requests=30, interval_seconds=MINUTE)
+@handle_rest_requests_exceptions
 async def request_product_account(request: web.Request):
     product = products_web.get_current_product(request)
-    session = await get_session(request)
+    session = await session_service.get_session(request)
 
     body = await parse_request_body_as(AccountRequestInfo, request)
     assert body.form  # nosec
     assert body.captcha  # nosec
 
     if body.captcha != session.get(CAPTCHA_SESSION_KEY):
-        raise web.HTTPUnprocessableEntity(
-            text=MSG_WRONG_CAPTCHA__INVALID, content_type=MIMETYPE_APPLICATION_JSON
-        )
+        raise web.HTTPUnprocessableEntity(text=MSG_WRONG_CAPTCHA__INVALID)
     session.pop(CAPTCHA_SESSION_KEY, None)
 
-    # send email to fogbugz or user itself
+    # create pre-regiatration or raise if already exists
+    await _preregistration_service.create_pre_registration(
+        request.app,
+        profile=PreRegisteredUserGet.model_validate(body.form),
+        product_name=product.name,
+    )
+
+    # if created send email to fogbugz or user itself
     fire_and_forget_task(
         _preregistration_service.send_account_request_email_to_support(
-            request,
+            request=request,
             product=product,
             request_form=body.form,
             ipinfo=_get_ipinfo(request),
@@ -98,6 +105,7 @@ class _AuthenticatedContext(BaseModel):
 @routes.post(f"/{API_VTAG}/auth/unregister", name="unregister_account")
 @login_required
 @permission_required("user.profile.delete")
+@handle_rest_requests_exceptions
 async def unregister_account(request: web.Request):
     req_ctx = _AuthenticatedContext.model_validate(request)
     body = await parse_request_body_as(UnregisterCheck, request)
@@ -108,7 +116,9 @@ async def unregister_account(request: web.Request):
     )
 
     # checks before deleting
-    credentials = await get_user_credentials(request.app, user_id=req_ctx.user_id)
+    credentials = await users_service.get_user_credentials(
+        request.app, user_id=req_ctx.user_id
+    )
     if body.email != credentials.email.lower() or not security_service.check_password(
         body.password.get_secret_value(), credentials.password_hash
     ):
@@ -124,7 +134,7 @@ async def unregister_account(request: web.Request):
         extra=get_log_record_extra(user_id=req_ctx.user_id),
     ):
         # update user table
-        await set_user_as_deleted(request.app, user_id=req_ctx.user_id)
+        await users_service.set_user_as_deleted(request.app, user_id=req_ctx.user_id)
 
         # logout
         await notify_user_logout(
@@ -150,8 +160,9 @@ async def unregister_account(request: web.Request):
 
 @routes.get(f"/{API_VTAG}/auth/captcha", name="create_captcha")
 @global_rate_limit_route(number_of_requests=30, interval_seconds=MINUTE)
+@handle_rest_requests_exceptions
 async def create_captcha(request: web.Request):
-    session = await get_session(request)
+    session = await session_service.get_session(request)
 
     captcha_text, image_data = await _preregistration_service.create_captcha()