✨ Refactor login module: replace legacy repository with confirmation service and clean up related tests

Author: pcrespov

packages/pytest-simcore/src/pytest_simcore/helpers/webserver_login.py

@@ -5,10 +5,10 @@
 
 from aiohttp.test_utils import TestClient
 from servicelib.aiohttp import status
-from simcore_service_webserver.login._invitations_service import create_invitation_token
-from simcore_service_webserver.login._login_repository_legacy import (
-    get_plugin_storage,
+from simcore_service_webserver.login._controller.rest._rest_dependencies import (
+    get_confirmation_service,
 )
+from simcore_service_webserver.login._invitations_service import create_invitation_token
 from simcore_service_webserver.login.constants import MSG_LOGGED_IN
 from simcore_service_webserver.security import security_service
 from yarl import URL
@@ -132,15 +132,15 @@ def __init__(
         self.confirmation = None
         self.trial_days = trial_days
         self.extra_credits_in_usd = extra_credits_in_usd
-        self.db = get_plugin_storage(self.app)
+        self.confirmation_service = get_confirmation_service(client.app)
 
     async def __aenter__(self) -> "NewInvitation":
         # creates host user
         assert self.client.app
         self.user = await super().__aenter__()
 
         self.confirmation = await create_invitation_token(
-            self.db,
+            self.client.app,
             user_id=self.user["id"],
             user_email=self.user["email"],
             tag=self.tag,
@@ -150,5 +150,11 @@ async def __aenter__(self) -> "NewInvitation":
         return self
 
     async def __aexit__(self, *args):
-        if await self.db.get_confirmation(self.confirmation):
-            await self.db.delete_confirmation(self.confirmation)
+        if self.confirmation:
+            # Try to get confirmation by filter and delete if it exists
+            confirmation = await self.confirmation_service.get_confirmation(
+                filter_dict={"code": self.confirmation["code"]}
+            )
+            if confirmation:
+                await self.confirmation_service.delete_confirmation(confirmation)
+        return await super().__aexit__(*args)

services/web/server/src/simcore_service_webserver/garbage_collector/plugin.py

@@ -5,7 +5,6 @@
 from servicelib.logging_utils import set_parent_module_log_level
 
 from ..application_settings import get_application_settings
-from ..login.plugin import setup_login_storage
 from ..products.plugin import setup_products
 from ..projects._projects_repository_legacy import setup_projects_db
 from ..redis import setup_redis
@@ -34,8 +33,6 @@ def setup_garbage_collector(app: web.Application) -> None:
 
     # - project needs access to socketio via notify_project_state_update
     setup_socketio(app)
-    # - project needs access to user-api that is connected to login plugin
-    setup_login_storage(app)
 
     settings = get_plugin_settings(app)
 

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

@@ -1,7 +1,5 @@
-import asyncio
 import logging
 
-import asyncpg
 from aiohttp import web
 from pydantic import ValidationError
 from servicelib.aiohttp.application_setup import (
@@ -10,15 +8,13 @@
     ensure_single_setup,
 )
 from settings_library.email import SMTPSettings
-from settings_library.postgres import PostgresSettings
 
 from ..constants import (
     APP_PUBLIC_CONFIG_PER_PRODUCT,
     APP_SETTINGS_KEY,
     INDEX_RESOURCE_NAME,
 )
 from ..db.plugin import setup_db
-from ..db.settings import get_plugin_settings as get_db_plugin_settings
 from ..email.plugin import setup_email
 from ..email.settings import get_plugin_settings as get_email_plugin_settings
 from ..invitations.plugin import setup_invitations
@@ -36,7 +32,6 @@
     registration,
     twofa,
 )
-from ._login_repository_legacy import APP_LOGIN_STORAGE_KEY, AsyncpgStorage
 from .constants import APP_LOGIN_SETTINGS_PER_PRODUCT_KEY
 from .settings import (
     APP_LOGIN_OPTIONS_KEY,
@@ -51,27 +46,6 @@
 MAX_TIME_TO_CLOSE_POOL_SECS = 5
 
 
-async def _setup_login_storage_ctx(app: web.Application):
-    assert APP_LOGIN_STORAGE_KEY not in app  # nosec
-    settings: PostgresSettings = get_db_plugin_settings(app)
-
-    async with asyncpg.create_pool(
-        dsn=settings.dsn_with_query,
-        min_size=settings.POSTGRES_MINSIZE,
-        max_size=settings.POSTGRES_MAXSIZE,
-        loop=asyncio.get_event_loop(),
-    ) as pool:
-        app[APP_LOGIN_STORAGE_KEY] = AsyncpgStorage(pool)
-
-        yield  # ----------------
-
-
-@ensure_single_setup(f"{__name__}.storage", logger=log)
-def setup_login_storage(app: web.Application):
-    if _setup_login_storage_ctx not in app.cleanup_ctx:
-        app.cleanup_ctx.append(_setup_login_storage_ctx)
-
-
 @ensure_single_setup(f"{__name__}.login_options", logger=log)
 def _setup_login_options(app: web.Application):
     settings: SMTPSettings = get_email_plugin_settings(app)
@@ -155,7 +129,6 @@ def setup_login(app: web.Application):
     app.router.add_routes(twofa.routes)
 
     _setup_login_options(app)
-    setup_login_storage(app)
 
     app.on_startup.append(_resolve_login_settings_per_product)
 

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

@@ -6,7 +6,6 @@
 from pathlib import Path
 
 import aiopg.sa
-import asyncpg
 import sqlalchemy as sa
 import yaml
 from aiohttp.test_utils import TestServer
@@ -19,10 +18,6 @@
     is_service_enabled,
     is_service_responsive,
 )
-from simcore_service_webserver.login._login_repository_legacy import (
-    AsyncpgStorage,
-    get_plugin_storage,
-)
 from sqlalchemy.ext.asyncio import AsyncEngine
 
 
@@ -44,29 +39,18 @@ async def test_all_pg_engines_in_app(web_server: TestServer):
     assert asyncpg_engine
     assert isinstance(asyncpg_engine, AsyncEngine)
 
-    # (3) low-level asyncpg Pool (deprecated)
-    # Will be replaced by (2)
-    login_storage: AsyncpgStorage = get_plugin_storage(app)
-    assert login_storage.pool
-    assert isinstance(login_storage.pool, asyncpg.Pool)
-
     # they ALL point to the SAME database
     assert aiopg_engine.dsn
     assert asyncpg_engine.url
 
     query = sa.text('SELECT "version_num" FROM "alembic_version"')
-    async with login_storage.pool.acquire() as conn:
-        result_pool = await conn.fetchval(str(query))
 
     async with asyncpg_engine.connect() as conn:
         result_asyncpg = (await conn.execute(query)).scalar_one_or_none()
 
     async with aiopg_engine.acquire() as conn:
         result_aiopg = await (await conn.execute(query)).scalar()
 
-    assert result_pool == result_asyncpg
-    assert result_pool == result_aiopg
-
 
 def test_uses_same_postgres_version(
     docker_compose_file: Path, osparc_simcore_root_dir: Path

services/web/server/tests/unit/with_dbs/01/test_db.py

@@ -21,10 +21,6 @@
     ConfirmationRepository,
 )
 from simcore_service_webserver.login._confirmation_service import ConfirmationService
-from simcore_service_webserver.login._login_repository_legacy import (
-    AsyncpgStorage,
-    get_plugin_storage,
-)
 from simcore_service_webserver.login.settings import LoginOptions, get_plugin_options
 
 
@@ -87,15 +83,6 @@ def fake_weak_password(faker: Faker) -> str:
     )
 
 
-@pytest.fixture
-def db_storage_deprecated(client: TestClient) -> AsyncpgStorage:
-    """login database repository instance"""
-    assert client.app
-    db: AsyncpgStorage = get_plugin_storage(client.app)
-    assert db
-    return db
-
-
 @pytest.fixture
 def confirmation_repository(client: TestClient) -> ConfirmationRepository:
     """Modern confirmation repository instance"""

services/web/server/tests/unit/with_dbs/03/login/conftest.py

@@ -24,7 +24,6 @@
     ConfirmationRepository,
 )
 from simcore_service_webserver.login._confirmation_web import _url_for_confirmation
-from simcore_service_webserver.login._login_repository_legacy import AsyncpgStorage
 from simcore_service_webserver.login.constants import (
     MSG_EMAIL_ALREADY_REGISTERED,
     MSG_LOGGED_IN,
@@ -243,7 +242,6 @@ async def test_registration_with_weak_password_fails(
 async def test_registration_with_invalid_confirmation_code(
     client: TestClient,
     login_options: LoginOptions,
-    db_storage_deprecated: AsyncpgStorage,
     mocker: MockerFixture,
     cleanup_db_tables: None,
 ):

services/web/server/tests/unit/with_dbs/03/login/test_login_registration.py

@@ -4,8 +4,7 @@
 # pylint: disable=too-many-arguments
 
 
-import contextlib
-from collections.abc import AsyncIterator, Callable
+from collections.abc import Callable
 
 import pytest
 from aiohttp.test_utils import TestClient, TestServer
@@ -16,12 +15,8 @@
 from servicelib.aiohttp import status
 from servicelib.rest_constants import X_PRODUCT_NAME_HEADER
 from servicelib.utils_secrets import generate_password
-from simcore_service_webserver.db.models import ConfirmationAction, UserStatus
+from simcore_service_webserver.db.models import UserStatus
 from simcore_service_webserver.groups import api as groups_service
-from simcore_service_webserver.login._login_repository_legacy import (
-    AsyncpgStorage,
-    ConfirmationTokenDict,
-)
 from simcore_service_webserver.login.constants import (
     MSG_ACTIVATION_REQUIRED,
     MSG_EMAIL_SENT,
@@ -295,16 +290,3 @@ async def test_unregistered_product(
             message.startswith("Password reset initiated")
             for message in logged_warnings
         ), f"Missing warning in {logged_warnings}"
-
-
-@contextlib.asynccontextmanager
-async def confirmation_ctx(
-    db: AsyncpgStorage, user
-) -> AsyncIterator[ConfirmationTokenDict]:
-    confirmation = await db.create_confirmation(
-        user["id"], ConfirmationAction.RESET_PASSWORD.name
-    )
-
-    yield confirmation
-
-    await db.delete_confirmation(confirmation)