connects other search options

Author: pcrespov

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

@@ -1,7 +1,8 @@
 import re
+from ast import TypeAlias
 from datetime import date, datetime
 from enum import Enum
-from typing import Annotated, Any, Literal, Self
+from typing import Annotated, Any, Literal, Self, TypeAlias
 
 import annotated_types
 from common_library.basic_types import DEFAULT_FACTORY
@@ -18,6 +19,7 @@
     StringConstraints,
     ValidationInfo,
     field_validator,
+    model_validator,
 )
 from pydantic.config import JsonDict
 
@@ -313,15 +315,40 @@ class UserAccountReject(InputSchema):
     email: EmailStr
 
 
+GlobString: TypeAlias = Annotated[
+    str,
+    StringConstraints(
+        min_length=3, max_length=200, strip_whitespace=True, pattern=r"^[^%]*$"
+    ),
+]
+
+
 class UserAccountSearchQueryParams(RequestParameters):
     email: Annotated[
-        str,
+        GlobString | None,
         Field(
-            min_length=3,
-            max_length=200,
             description="complete or glob pattern for an email",
         ),
-    ]
+    ] = None
+    primary_group_id: Annotated[
+        GroupID | None,
+        Field(
+            description="Filter by primary group ID",
+        ),
+    ] = None
+    user_name: Annotated[
+        GlobString | None,
+        Field(
+            description="complete or glob pattern for a username",
+        ),
+    ] = None
+
+    @model_validator(mode="after")
+    def _validate_at_least_one_filter(self) -> Self:
+        if not any([self.email, self.primary_group_id, self.user_name]):
+            msg = "At least one filter (email, primary_group_id, or user_name) must be provided"
+            raise ValueError(msg)
+        return self
 
 
 class UserAccountGet(OutputSchema):

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

@@ -36,7 +36,10 @@ async def pre_register_user(
 ) -> UserAccountGet:
 
     found = await search_users_accounts(
-        app, email_glob=profile.email, product_name=product_name, include_products=False
+        app,
+        filter_by_email_glob=profile.email,
+        product_name=product_name,
+        include_products=False,
     )
     if found:
         raise AlreadyPreRegisteredError(num_found=len(found), email=profile.email)
@@ -70,7 +73,10 @@ async def pre_register_user(
     )
 
     found = await search_users_accounts(
-        app, email_glob=profile.email, product_name=product_name, include_products=False
+        app,
+        filter_by_email_glob=profile.email,
+        product_name=product_name,
+        include_products=False,
     )
 
     assert len(found) == 1  # nosec
@@ -143,7 +149,9 @@ async def list_user_accounts(
 async def search_users_accounts(
     app: web.Application,
     *,
-    email_glob: str,
+    filter_by_email_glob: str | None = None,
+    filter_by_primary_group_id: int | None = None,
+    filter_by_user_name_glob: str | None = None,
     product_name: ProductName | None = None,
     include_products: bool = False,
 ) -> list[UserAccountGet]:
@@ -156,6 +164,14 @@ async def search_users_accounts(
     no caller or context is available.
     """
 
+    if (
+        filter_by_email_glob is None
+        and filter_by_user_name_glob is None
+        and filter_by_primary_group_id is None
+    ):
+        msg = "At least one filter (email glob, user name like, or primary group ID) must be provided"
+        raise ValueError(msg)
+
     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"\_")
@@ -164,7 +180,15 @@ def _glob_to_sql_like(glob_pattern: str) -> str:
 
     rows = await _accounts_repository.search_merged_pre_and_registered_users(
         get_asyncpg_engine(app),
-        filter_by_email_like=_glob_to_sql_like(email_glob),
+        filter_by_email_like=(
+            _glob_to_sql_like(filter_by_email_glob) if filter_by_email_glob else None
+        ),
+        filter_by_primary_group_id=filter_by_primary_group_id,
+        filter_by_user_name_like=(
+            _glob_to_sql_like(filter_by_user_name_glob)
+            if filter_by_user_name_glob
+            else None
+        ),
         product_name=product_name,
     )
 

services/web/server/src/simcore_service_webserver/users/_controller/rest/accounts_rest.py

@@ -113,7 +113,11 @@ async def search_user_accounts(request: web.Request) -> web.Response:
     )
 
     found = await _accounts_service.search_users_accounts(
-        request.app, email_glob=query_params.email, include_products=True
+        request.app,
+        filter_by_email_glob=query_params.email,
+        filter_by_primary_group_id=query_params.primary_group_id,
+        filter_by_user_name_glob=query_params.user_name,
+        include_products=True,
     )
 
     return envelope_json_response(
@@ -214,7 +218,7 @@ async def approve_user_account(request: web.Request) -> web.Response:
             # get pre-registration data
             found = await _accounts_service.search_users_accounts(
                 request.app,
-                email_glob=approval_data.email,
+                filter_by_email_glob=approval_data.email,
                 product_name=req_ctx.product_name,
                 include_products=False,
             )
@@ -270,7 +274,7 @@ async def reject_user_account(request: web.Request) -> web.Response:
         # get pre-registration data
         found = await _accounts_service.search_users_accounts(
             request.app,
-            email_glob=rejection_data.email,
+            filter_by_email_glob=rejection_data.email,
             product_name=req_ctx.product_name,
             include_products=False,
         )

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

@@ -83,7 +83,10 @@ async def test_search_users_as_admin_real_user(
 
     # Act
     found_users = await _accounts_service.search_users_accounts(
-        app, email_glob=user_email, product_name=product_name, include_products=False
+        app,
+        filter_by_email_glob=user_email,
+        product_name=product_name,
+        include_products=False,
     )
 
     # Assert
@@ -112,7 +115,7 @@ async def test_search_users_as_admin_pre_registered_user(
 
     # Act
     found_users = await _accounts_service.search_users_accounts(
-        app, email_glob=pre_registered_email, product_name=product_name
+        app, filter_by_email_glob=pre_registered_email, product_name=product_name
     )
 
     # Assert
@@ -165,7 +168,7 @@ async def test_search_users_as_admin_wildcard(
 
     # Act - search with wildcard for the domain
     found_users = await _accounts_service.search_users_accounts(
-        app, email_glob=f"*{email_domain}", product_name=product_name
+        app, filter_by_email_glob=f"*{email_domain}", product_name=product_name
     )
 
     # Assert