♻️ Major Refactor: Isolate webserver's user Subdomains & Modernize Internal Structure (🚨) (#8083)

Author: pcrespov

api/specs/web-server/_users.py

@@ -14,20 +14,22 @@
     MyProfilePatch,
     MyTokenCreate,
     MyTokenGet,
+    TokenPathParams,
     UserGet,
     UsersSearch,
 )
 from models_library.api_schemas_webserver.users_preferences import PatchRequestBody
 from models_library.generics import Envelope
 from models_library.user_preferences import PreferenceIdentifier
 from simcore_service_webserver._meta import API_VTAG
-from simcore_service_webserver.users._notifications import (
+from simcore_service_webserver.user_notifications._controller.rest.user_notification_rest import (
+    NotificationPathParams,
+)
+from simcore_service_webserver.user_notifications._models import (
     UserNotification,
     UserNotificationCreate,
     UserNotificationPatch,
 )
-from simcore_service_webserver.users._notifications_rest import _NotificationPathParams
-from simcore_service_webserver.users._tokens_rest import _TokenPathParams
 
 router = APIRouter(prefix=f"/{API_VTAG}", tags=["users"])
 
@@ -76,15 +78,15 @@ async def create_token(_body: MyTokenCreate): ...
     response_model=Envelope[MyTokenGet],
 )
 async def get_token(
-    _path: Annotated[_TokenPathParams, Depends()],
+    _path: Annotated[TokenPathParams, Depends()],
 ): ...
 
 
 @router.delete(
     "/me/tokens/{service}",
     status_code=status.HTTP_204_NO_CONTENT,
 )
-async def delete_token(_path: Annotated[_TokenPathParams, Depends()]): ...
+async def delete_token(_path: Annotated[TokenPathParams, Depends()]): ...
 
 
 @router.get(
@@ -108,7 +110,7 @@ async def create_user_notification(
     status_code=status.HTTP_204_NO_CONTENT,
 )
 async def mark_notification_as_read(
-    _path: Annotated[_NotificationPathParams, Depends()],
+    _path: Annotated[NotificationPathParams, Depends()],
     _body: UserNotificationPatch,
 ): ...
 

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

@@ -11,6 +11,7 @@
 from models_library.rest_filters import Filters
 from models_library.rest_pagination import PageQueryParameters
 from pydantic import (
+    BaseModel,
     ConfigDict,
     EmailStr,
     Field,
@@ -334,6 +335,10 @@ def _consistency_check(cls, v, info: ValidationInfo):
 #
 
 
+class TokenPathParams(BaseModel):
+    service: str
+
+
 class MyTokenCreate(InputSchemaWithoutCamelCase):
     service: Annotated[
         IDStr,

packages/service-library/src/servicelib/aiohttp/observer.py

@@ -8,6 +8,7 @@
 from collections.abc import Callable
 
 from aiohttp import web
+from servicelib.aiohttp.application_setup import ensure_single_setup
 
 from ..utils import logged_gather
 
@@ -17,10 +18,10 @@
 _APP_OBSERVER_EVENTS_REGISTRY_KEY = "{__name__}.event_registry"
 
 
-class ObserverRegistryNotFoundError(RuntimeError):
-    ...
+class ObserverRegistryNotFoundError(RuntimeError): ...
 
 
+@ensure_single_setup(__name__, logger=log)
 def setup_observer_registry(app: web.Application):
     # only once
     app.setdefault(_APP_OBSERVER_EVENTS_REGISTRY_KEY, defaultdict(list))

services/web/server/src/simcore_service_webserver/conversations/_conversation_message_service.py

@@ -17,7 +17,7 @@
 from models_library.users import UserID
 
 # Import or define SocketMessageDict
-from ..users.api import get_user_primary_group_id
+from ..users import users_service
 from . import _conversation_message_repository
 from ._conversation_service import _get_recipients
 from ._socketio import (
@@ -39,7 +39,7 @@ async def create_message(
     content: str,
     type_: ConversationMessageType,
 ) -> ConversationMessageGetDB:
-    _user_group_id = await get_user_primary_group_id(app, user_id=user_id)
+    _user_group_id = await users_service.get_user_primary_group_id(app, user_id=user_id)
 
     created_message = await _conversation_message_repository.create(
         app,
@@ -110,7 +110,7 @@ async def delete_message(
         message_id=message_id,
     )
 
-    _user_group_id = await get_user_primary_group_id(app, user_id=user_id)
+    _user_group_id = await users_service.get_user_primary_group_id(app, user_id=user_id)
 
     await notify_conversation_message_deleted(
         app,

services/web/server/src/simcore_service_webserver/conversations/_conversation_service.py

@@ -22,8 +22,8 @@
     notify_conversation_updated,
 )
 from ..projects._groups_repository import list_project_groups
+from ..users import users_service
 from ..users._users_service import get_users_in_group
-from ..users.api import get_user_primary_group_id
 from . import _conversation_repository
 
 _logger = logging.getLogger(__name__)
@@ -52,7 +52,7 @@ async def create_conversation(
     if project_uuid is None:
         raise NotImplementedError
 
-    _user_group_id = await get_user_primary_group_id(app, user_id=user_id)
+    _user_group_id = await users_service.get_user_primary_group_id(app, user_id=user_id)
 
     created_conversation = await _conversation_repository.create(
         app,
@@ -121,7 +121,7 @@ async def delete_conversation(
         conversation_id=conversation_id,
     )
 
-    _user_group_id = await get_user_primary_group_id(app, user_id=user_id)
+    _user_group_id = await users_service.get_user_primary_group_id(app, user_id=user_id)
 
     await notify_conversation_deleted(
         app,

services/web/server/src/simcore_service_webserver/director_v2/_director_v2_service.py

@@ -28,7 +28,7 @@
 from ..products import products_service
 from ..products.models import Product
 from ..projects import projects_wallets_service
-from ..users import preferences_api as user_preferences_service
+from ..user_preferences import user_preferences_service
 from ..users.exceptions import UserDefaultWalletNotFoundError
 from ..wallets import api as wallets_service
 from ._client import DirectorV2RestClient

services/web/server/src/simcore_service_webserver/exporter/_handlers.py

@@ -18,7 +18,7 @@
 from ..projects._projects_service import create_user_notification_cb
 from ..redis import get_redis_lock_manager_client_sdk
 from ..security.decorators import permission_required
-from ..users.api import get_user_fullname
+from ..users import users_service
 from ._formatter.archive import get_sds_archive_path
 from .exceptions import SDSException
 from .utils import CleanupFileResponse
@@ -52,7 +52,8 @@ async def export_project(request: web.Request):
         project_uuid=project_uuid,
         status=ProjectStatus.EXPORTING,
         owner=Owner(
-            user_id=user_id, **await get_user_fullname(request.app, user_id=user_id)
+            user_id=user_id,
+            **await users_service.get_user_fullname(request.app, user_id=user_id),
         ),
         notification_cb=create_user_notification_cb(
             user_id, ProjectID(f"{project_uuid}"), request.app

services/web/server/src/simcore_service_webserver/folders/_folders_service.py

@@ -13,7 +13,7 @@
 from pydantic import NonNegativeInt
 
 from ..projects._projects_service import delete_project_by_user
-from ..users.api import get_user
+from ..users.users_service import get_user
 from ..workspaces.api import check_user_workspace_access
 from ..workspaces.errors import (
     WorkspaceAccessForbiddenError,

services/web/server/src/simcore_service_webserver/folders/_workspaces_repository.py

@@ -12,7 +12,7 @@
 from ..projects import _groups_repository as projects_groups_repository
 from ..projects import _projects_repository as _projects_repository
 from ..projects._access_rights_service import check_user_project_permission
-from ..users.api import get_user
+from ..users import users_service
 from ..workspaces.api import check_user_workspace_access
 from . import _folders_repository
 
@@ -122,7 +122,7 @@ async def move_folder_into_workspace(
         )
 
         # 9. Remove all project permissions, leave only the user who moved the project
-        user = await get_user(app, user_id=user_id)
+        user = await users_service.get_user(app, user_id=user_id)
         for project_id in project_ids:
             await projects_groups_repository.delete_all_project_groups(
                 app, connection=conn, project_id=project_id

services/web/server/src/simcore_service_webserver/functions/_functions_repository.py

@@ -88,7 +88,7 @@
 
 from ..db.plugin import get_asyncpg_engine
 from ..groups.api import list_all_user_groups_ids
-from ..users.api import get_user_primary_group_id
+from ..users import users_service
 
 _FUNCTIONS_TABLE_COLS = get_columns_from_db_model(functions_table, RegisteredFunctionDB)
 _FUNCTION_JOBS_TABLE_COLS = get_columns_from_db_model(
@@ -148,7 +148,9 @@ async def create_function(  # noqa: PLR0913
 
         registered_function = RegisteredFunctionDB.model_validate(row)
 
-        user_primary_group_id = await get_user_primary_group_id(app, user_id=user_id)
+        user_primary_group_id = await users_service.get_user_primary_group_id(
+            app, user_id=user_id
+        )
         await set_group_permissions(
             app,
             connection=transaction,
@@ -206,7 +208,9 @@ async def create_function_job(  # noqa: PLR0913
 
         registered_function_job = RegisteredFunctionJobDB.model_validate(row)
 
-        user_primary_group_id = await get_user_primary_group_id(app, user_id=user_id)
+        user_primary_group_id = await users_service.get_user_primary_group_id(
+            app, user_id=user_id
+        )
         await set_group_permissions(
             app,
             connection=transaction,
@@ -291,7 +295,9 @@ async def create_function_job_collection(
             )  # nosec
             job_collection_entries.append(entry)
 
-        user_primary_group_id = await get_user_primary_group_id(app, user_id=user_id)
+        user_primary_group_id = await users_service.get_user_primary_group_id(
+            app, user_id=user_id
+        )
         await set_group_permissions(
             app,
             connection=transaction,