cleanup

Author: pcrespov

services/web/server/src/simcore_service_webserver/users/_users_rest.py

@@ -196,7 +196,7 @@ async def list_users_accounts(request: web.Request) -> web.Response:
         # ALL
         filter_any_account_request_status = None
 
-    users, total_count = await _users_service.list_all_users_as_admin(
+    users, total_count = await _users_service.list_user_accounts(
         request.app,
         product_name=req_ctx.product_name,
         filter_any_account_request_status=filter_any_account_request_status,
@@ -234,7 +234,7 @@ async def search_user_accounts(request: web.Request) -> web.Response:
         UserAccountSearchQueryParams, request
     )
 
-    found = await _users_service.search_users_as_admin(
+    found = await _users_service.search_users_accounts(
         request.app, email_glob=query_params.email, include_products=True
     )
 

services/web/server/src/simcore_service_webserver/users/_users_service.py

@@ -49,7 +49,7 @@ async def pre_register_user(
     product_name: ProductName,
 ) -> UserAccountGet:
 
-    found = await search_users_as_admin(
+    found = await search_users_accounts(
         app, email_glob=profile.email, product_name=product_name, include_products=False
     )
     if found:
@@ -83,7 +83,7 @@ async def pre_register_user(
         **details,
     )
 
-    found = await search_users_as_admin(
+    found = await search_users_accounts(
         app, email_glob=profile.email, product_name=product_name, include_products=False
     )
 
@@ -134,69 +134,6 @@ async def get_user_id_from_gid(app: web.Application, primary_gid: GroupID) -> Us
     return await _users_repository.get_user_id_from_pgid(app, primary_gid=primary_gid)
 
 
-async def search_users_as_admin(
-    app: web.Application,
-    *,
-    email_glob: str,
-    product_name: ProductName | None = None,
-    include_products: bool = False,
-) -> list[UserAccountGet]:
-    """
-    WARNING: this information is reserved for admin users. Note that the returned model include UserForAdminGet
-
-    NOTE: Functions in the service layer typically validate the caller's access rights
-    using parameters like product_name and user_id. However, this function skips
-    such checks as it is designed for scenarios (e.g., background tasks) where
-    no caller or context is available.
-    """
-
-    def _glob_to_sql_like(glob_pattern: str) -> str:
-        # Escape SQL LIKE special characters in the glob pattern
-        sql_like_pattern = glob_pattern.replace("%", r"\%").replace("_", r"\_")
-        # Convert glob wildcards to SQL LIKE wildcards
-        return sql_like_pattern.replace("*", "%").replace("?", "_")
-
-    rows = await _users_repository.search_merged_pre_and_registered_users(
-        get_asyncpg_engine(app),
-        email_like=_glob_to_sql_like(email_glob),
-        product_name=product_name,
-    )
-
-    async def _list_products_or_none(user_id):
-        if user_id is not None and include_products:
-            products = await _users_repository.get_user_products(
-                get_asyncpg_engine(app), user_id=user_id
-            )
-            return [_.product_name for _ in products]
-        return None
-
-    return [
-        UserAccountGet(
-            first_name=r.first_name or r.pre_first_name,
-            last_name=r.last_name or r.pre_last_name,
-            email=r.email or r.pre_email,
-            institution=r.institution,
-            phone=r.phone or r.pre_phone,
-            address=r.address,
-            city=r.city,
-            state=r.state,
-            postal_code=r.postal_code,
-            country=r.country,
-            extras=r.extras or {},
-            invited_by=r.invited_by,
-            pre_registration_id=r.id,
-            account_request_status=r.account_request_status,
-            account_request_reviewed_by=r.account_request_reviewed_by,
-            account_request_reviewed_at=r.account_request_reviewed_at,
-            products=await _list_products_or_none(r.user_id),
-            # NOTE: old users will not have extra details
-            registered=r.user_id is not None if r.pre_email else r.status is not None,
-            status=r.status,
-        )
-        for r in rows
-    ]
-
-
 async def get_users_in_group(app: web.Application, *, gid: GroupID) -> set[UserID]:
     return await _users_repository.get_users_ids_in_group(
         get_asyncpg_engine(app), group_id=gid
@@ -214,64 +151,6 @@ async def is_user_in_product(
     )
 
 
-async def list_all_users_as_admin(
-    app: web.Application,
-    *,
-    product_name: ProductName,
-    filter_any_account_request_status: list[AccountRequestStatus] | None = None,
-    pagination_limit: int = 50,
-    pagination_offset: int = 0,
-) -> tuple[list[dict[str, Any]], int]:
-    """
-    Get a paginated list of users for admin view with filtering options.
-
-    Args:
-        app: The web application instance
-        filter_approved: If set, filters users by their approval status
-        pagination_limit: Maximum number of users to return
-        pagination_offset: Number of users to skip for pagination
-
-    Returns:
-        A tuple containing (list of user dictionaries, total count of users)
-    """
-    engine = get_asyncpg_engine(app)
-
-    # Get user data with pagination
-    users_data, total_count = (
-        await _users_repository.list_merged_pre_and_registered_users(
-            engine,
-            product_name=product_name,
-            filter_any_account_request_status=filter_any_account_request_status,
-            pagination_limit=pagination_limit,
-            pagination_offset=pagination_offset,
-        )
-    )
-
-    # For each user, append additional information if needed
-    result = []
-    for user in users_data:
-        # Add any additional processing needed for admin view
-        user_dict = dict(user)
-
-        # Add products information if needed
-        user_id = user.get("user_id")
-        if user_id:
-            products = await _users_repository.get_user_products(
-                engine, user_id=user_id
-            )
-            user_dict["products"] = [p.product_name for p in products]
-
-        user_dict["registered"] = (
-            user_id is not None
-            if user.get("pre_email")
-            else user.get("status") is not None
-        )
-
-        result.append(user_dict)
-
-    return result, total_count
-
-
 #
 # GET USER PROPERTIES
 #
@@ -456,6 +335,132 @@ async def update_my_profile(
     )
 
 
+#
+# USER ACCOUNTS
+#
+
+
+async def list_user_accounts(
+    app: web.Application,
+    *,
+    product_name: ProductName,
+    filter_any_account_request_status: list[AccountRequestStatus] | None = None,
+    pagination_limit: int = 50,
+    pagination_offset: int = 0,
+) -> tuple[list[dict[str, Any]], int]:
+    """
+    Get a paginated list of users for admin view with filtering options.
+
+    Args:
+        app: The web application instance
+        filter_approved: If set, filters users by their approval status
+        pagination_limit: Maximum number of users to return
+        pagination_offset: Number of users to skip for pagination
+
+    Returns:
+        A tuple containing (list of user dictionaries, total count of users)
+    """
+    engine = get_asyncpg_engine(app)
+
+    # Get user data with pagination
+    users_data, total_count = (
+        await _users_repository.list_merged_pre_and_registered_users(
+            engine,
+            product_name=product_name,
+            filter_any_account_request_status=filter_any_account_request_status,
+            pagination_limit=pagination_limit,
+            pagination_offset=pagination_offset,
+        )
+    )
+
+    # For each user, append additional information if needed
+    result = []
+    for user in users_data:
+        # Add any additional processing needed for admin view
+        user_dict = dict(user)
+
+        # Add products information if needed
+        user_id = user.get("user_id")
+        if user_id:
+            products = await _users_repository.get_user_products(
+                engine, user_id=user_id
+            )
+            user_dict["products"] = [p.product_name for p in products]
+
+        user_dict["registered"] = (
+            user_id is not None
+            if user.get("pre_email")
+            else user.get("status") is not None
+        )
+
+        result.append(user_dict)
+
+    return result, total_count
+
+
+async def search_users_accounts(
+    app: web.Application,
+    *,
+    email_glob: str,
+    product_name: ProductName | None = None,
+    include_products: bool = False,
+) -> list[UserAccountGet]:
+    """
+    WARNING: this information is reserved for admin users. Note that the returned model include UserForAdminGet
+
+    NOTE: Functions in the service layer typically validate the caller's access rights
+    using parameters like product_name and user_id. However, this function skips
+    such checks as it is designed for scenarios (e.g., background tasks) where
+    no caller or context is available.
+    """
+
+    def _glob_to_sql_like(glob_pattern: str) -> str:
+        # Escape SQL LIKE special characters in the glob pattern
+        sql_like_pattern = glob_pattern.replace("%", r"\%").replace("_", r"\_")
+        # Convert glob wildcards to SQL LIKE wildcards
+        return sql_like_pattern.replace("*", "%").replace("?", "_")
+
+    rows = await _users_repository.search_merged_pre_and_registered_users(
+        get_asyncpg_engine(app),
+        email_like=_glob_to_sql_like(email_glob),
+        product_name=product_name,
+    )
+
+    async def _list_products_or_none(user_id):
+        if user_id is not None and include_products:
+            products = await _users_repository.get_user_products(
+                get_asyncpg_engine(app), user_id=user_id
+            )
+            return [_.product_name for _ in products]
+        return None
+
+    return [
+        UserAccountGet(
+            first_name=r.first_name or r.pre_first_name,
+            last_name=r.last_name or r.pre_last_name,
+            email=r.email or r.pre_email,
+            institution=r.institution,
+            phone=r.phone or r.pre_phone,
+            address=r.address,
+            city=r.city,
+            state=r.state,
+            postal_code=r.postal_code,
+            country=r.country,
+            extras=r.extras or {},
+            invited_by=r.invited_by,
+            pre_registration_id=r.id,
+            account_request_status=r.account_request_status,
+            account_request_reviewed_by=r.account_request_reviewed_by,
+            account_request_reviewed_at=r.account_request_reviewed_at,
+            products=await _list_products_or_none(r.user_id),
+            # NOTE: old users will not have extra details
+            registered=r.user_id is not None if r.pre_email else r.status is not None,
+            status=r.status,
+        )
+        for r in rows
+    ]
+
+
 async def approve_user_account(
     app: web.Application,
     *,

services/web/server/tests/unit/with_dbs/03/users/test_users_service.py

@@ -82,7 +82,7 @@ async def test_search_users_as_admin_real_user(
     user_email = product_owner_user["email"]
 
     # Act
-    found_users = await _users_service.search_users_as_admin(
+    found_users = await _users_service.search_users_accounts(
         app, email_glob=user_email, product_name=product_name, include_products=False
     )
 
@@ -111,7 +111,7 @@ async def test_search_users_as_admin_pre_registered_user(
     pre_registration_details = pre_registered_user_created["details"]
 
     # Act
-    found_users = await _users_service.search_users_as_admin(
+    found_users = await _users_service.search_users_accounts(
         app, email_glob=pre_registered_email, product_name=product_name
     )
 
@@ -164,7 +164,7 @@ async def test_search_users_as_admin_wildcard(
         )
 
     # Act - search with wildcard for the domain
-    found_users = await _users_service.search_users_as_admin(
+    found_users = await _users_service.search_users_accounts(
         app, email_glob=f"*{email_domain}", product_name=product_name
     )