✨ Refactor confirmation service integration: centralize service retrieval in _rest_dependencies.py

Author: pcrespov

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

@@ -0,0 +1,24 @@
+"""Common dependency injection helpers for REST controllers.
+
+This module provides factory functions for creating service instances
+that are commonly used across multiple REST controllers in the login module.
+"""
+
+from aiohttp import web
+
+from ....db.plugin import get_asyncpg_engine
+from ..._confirmation_repository import ConfirmationRepository
+from ..._confirmation_service import ConfirmationService
+from ...settings import get_plugin_options
+
+
+def get_confirmation_service(app: web.Application) -> ConfirmationService:
+    """Get confirmation service instance from app.
+
+    Creates a ConfirmationService with proper repository and options injection.
+    Used across multiple REST controllers for confirmation operations.
+    """
+    engine = get_asyncpg_engine(app)
+    repository = ConfirmationRepository(engine)
+    options = get_plugin_options(app)
+    return ConfirmationService(repository, options)

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

@@ -16,8 +16,6 @@
 from ....utils_rate_limiting import global_rate_limit_route
 from ....web_utils import flash_response
 from ... import _auth_service, _confirmation_web
-from ..._confirmation_repository import ConfirmationRepository
-from ..._confirmation_service import ConfirmationService
 from ..._emails_service import get_template_path, send_email_from_template
 from ..._login_service import (
     ACTIVE,
@@ -34,20 +32,12 @@
 )
 from ...decorators import login_required
 from ...errors import WrongPasswordError
-from ...settings import get_plugin_options
+from ._rest_dependencies import get_confirmation_service
 from .change_schemas import ChangeEmailBody, ChangePasswordBody, ResetPasswordBody
 
 _logger = logging.getLogger(__name__)
 
 
-def _get_confirmation_service(app: web.Application) -> ConfirmationService:
-    """Get confirmation service instance from app."""
-    engine = app["postgres_db_engine"]
-    repository = ConfirmationRepository(engine)
-    options = get_plugin_options(app)
-    return ConfirmationService(repository, options)
-
-
 routes = RouteTableDef()
 
 
@@ -184,7 +174,7 @@ def _get_error_context(
         try:
             # Confirmation token that includes code to `complete_reset_password`.
             # Recreated if non-existent or expired  (Guideline #2)
-            confirmation_service = _get_confirmation_service(request.app)
+            confirmation_service = get_confirmation_service(request.app)
             confirmation = (
                 await confirmation_service.get_or_create_confirmation_without_data(
                     user_id=user["id"], action="RESET_PASSWORD"
@@ -227,7 +217,7 @@ def _get_error_context(
 async def initiate_change_email(request: web.Request):
     # NOTE: This code have been intentially disabled in https://github.com/ITISFoundation/osparc-simcore/pull/5472
     product: Product = products_web.get_current_product(request)
-    confirmation_service = _get_confirmation_service(request.app)
+    confirmation_service = get_confirmation_service(request.app)
 
     request_body = await parse_request_body_as(ChangeEmailBody, request)
 

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

@@ -30,8 +30,6 @@
     _security_service,
     _twofa_service,
 )
-from ..._confirmation_repository import ConfirmationRepository
-from ..._confirmation_service import ConfirmationService
 from ..._login_repository_legacy import (
     ConfirmationTokenDict,
 )
@@ -54,6 +52,7 @@
     get_plugin_options,
     get_plugin_settings,
 )
+from ._rest_dependencies import get_confirmation_service
 from .confirmation_schemas import (
     CodePathParam,
     PhoneConfirmationBody,
@@ -64,14 +63,6 @@
 _logger = logging.getLogger(__name__)
 
 
-def _get_confirmation_service(app: web.Application) -> ConfirmationService:
-    """Get confirmation service instance from app."""
-    engine = app["postgres_db_engine"]
-    repository = ConfirmationRepository(engine)
-    options = get_plugin_options(app)
-    return ConfirmationService(repository, options)
-
-
 def _confirmation_to_legacy_dict(confirmation: Confirmation) -> ConfirmationTokenDict:
     """Convert new Confirmation model to legacy ConfirmationTokenDict format."""
     return {
@@ -91,7 +82,7 @@ async def _handle_confirm_registration(
     product_name: ProductName,
     confirmation: Confirmation,
 ):
-    confirmation_service = _get_confirmation_service(app)
+    confirmation_service = get_confirmation_service(app)
     user_id = confirmation.user_id
 
     # activate user and consume confirmation token
@@ -114,7 +105,7 @@ async def _handle_confirm_registration(
 async def _handle_confirm_change_email(
     app: web.Application, confirmation: Confirmation
 ):
-    confirmation_service = _get_confirmation_service(app)
+    confirmation_service = get_confirmation_service(app)
     user_id = confirmation.user_id
 
     # update and consume confirmation token
@@ -146,7 +137,7 @@ async def validate_confirmation_and_redirect(request: web.Request):
     """
     cfg: LoginOptions = get_plugin_options(request.app)
     product: Product = products_web.get_current_product(request)
-    confirmation_service = _get_confirmation_service(request.app)
+    confirmation_service = get_confirmation_service(request.app)
 
     path_params = parse_request_path_parameters_as(CodePathParam, request)
 
@@ -267,7 +258,7 @@ async def complete_reset_password(request: web.Request):
     - Code is provided via email by calling first initiate_reset_password
     """
     product: Product = products_web.get_current_product(request)
-    confirmation_service = _get_confirmation_service(request.app)
+    confirmation_service = get_confirmation_service(request.app)
 
     path_params = parse_request_path_parameters_as(CodePathParam, request)
     request_body = await parse_request_body_as(ResetPasswordConfirmation, request)

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

@@ -30,8 +30,6 @@
     _security_service,
     _twofa_service,
 )
-from ..._confirmation_repository import ConfirmationRepository
-from ..._confirmation_service import ConfirmationService
 from ..._emails_service import get_template_path, send_email_from_template
 from ..._invitations_service import (
     ConfirmedInvitationData,
@@ -54,9 +52,9 @@
 )
 from ...settings import (
     LoginSettingsForProduct,
-    get_plugin_options,
     get_plugin_settings,
 )
+from ._rest_dependencies import get_confirmation_service
 from .registration_schemas import (
     InvitationCheck,
     InvitationInfo,
@@ -67,14 +65,6 @@
 _logger = logging.getLogger(__name__)
 
 
-def _get_confirmation_service(app: web.Application) -> ConfirmationService:
-    """Get confirmation service instance from app."""
-    engine = app["postgres_db_engine"]
-    repository = ConfirmationRepository(engine)
-    options = get_plugin_options(app)
-    return ConfirmationService(repository, options)
-
-
 routes = RouteTableDef()
 
 
@@ -225,7 +215,7 @@ async def register(request: web.Request):
 
     if settings.LOGIN_REGISTRATION_CONFIRMATION_REQUIRED:
         # Confirmation required: send confirmation email
-        confirmation_service = _get_confirmation_service(request.app)
+        confirmation_service = get_confirmation_service(request.app)
         _confirmation: Confirmation = await confirmation_service.create_confirmation(
             user_id=user["id"],
             action="REGISTRATION",

services/web/server/src/simcore_service_webserver/login/_invitations_service.py

@@ -42,8 +42,7 @@
 from ..products.models import Product
 from ..users import users_service
 from . import _auth_service
-from ._confirmation_repository import ConfirmationRepository
-from ._confirmation_service import ConfirmationService
+from ._controller.rest._rest_dependencies import get_confirmation_service
 from ._login_repository_legacy import (
     BaseConfirmationTokenDict,
     ConfirmationTokenDict,
@@ -53,19 +52,10 @@
     MSG_INVITATIONS_CONTACT_SUFFIX,
     MSG_USER_DISABLED,
 )
-from .settings import get_plugin_options
 
 _logger = logging.getLogger(__name__)
 
 
-def _get_confirmation_service(app: web.Application) -> ConfirmationService:
-    """Get confirmation service instance from app."""
-    engine = app["postgres_db_engine"]
-    repository = ConfirmationRepository(engine)
-    options = get_plugin_options(app)
-    return ConfirmationService(repository, options)
-
-
 class ConfirmationTokenInfoDict(ConfirmationTokenDict):
     expires: datetime
     url: str
@@ -140,7 +130,7 @@ async def check_other_registrations(
                 #  w/ an expired confirmation will get deleted and its account (i.e. email)
                 #  can be overtaken by this new registration
                 #
-                confirmation_service = _get_confirmation_service(app)
+                confirmation_service = get_confirmation_service(app)
                 _confirmation = await confirmation_service.get_confirmation(
                     filter_dict={
                         "user_id": user["id"],
@@ -206,7 +196,7 @@ async def create_invitation_token(
         trial_account_days=trial_days,
         extra_credits_in_usd=extra_credits_in_usd,
     )
-    confirmation_service = _get_confirmation_service(app)
+    confirmation_service = get_confirmation_service(app)
     confirmation = await confirmation_service.create_confirmation(
         user_id=user_id,
         action=ConfirmationAction.INVITATION.name,
@@ -319,7 +309,7 @@ async def check_and_consume_invitation(
             )
 
     # database-type invitations
-    confirmation_service = _get_confirmation_service(app)
+    confirmation_service = get_confirmation_service(app)
     if confirmation := await confirmation_service.validate_confirmation_code(
         invitation_code
     ):