26087 - Auth API: support affiliations search parameters (#3361)

Author: Rajandeep98

auth-api/src/auth_api/models/dataclass.py

@@ -14,7 +14,9 @@
 """This module holds data classes."""
 
 from dataclasses import dataclass, field
-from typing import List, Optional
+from typing import List, Optional, Self
+
+from requests import Request
 
 from auth_api.utils.enums import KeycloakGroupActions
 
@@ -47,6 +49,29 @@ class AffiliationInvitationSearch:  # pylint: disable=too-many-instance-attribut
     is_deleted: bool = False
 
 
+@dataclass
+class AffiliationSearchDetails:  # pylint: disable=too-many-instance-attributes
+    """Used for filtering Affiliations based on filters passed."""
+
+    identifier: Optional[str]
+    status: Optional[str]
+    name: Optional[str]
+    type: Optional[str]
+    page: int
+    limit: int
+
+    @classmethod
+    def from_request_args(cls, req: Request) -> Self:
+        return cls(
+            identifier=req.args.get("identifier"),
+            status=req.args.getlist("status") or [],
+            name=req.args.get("name"),
+            type=req.args.getlist("type") or [],
+            page=int(req.args.get("page", 1)),
+            limit=int(req.args.get("limit", 100000)),
+        )
+
+
 @dataclass
 class AffiliationInvitationData:  # pylint: disable=too-many-instance-attributes
     """Used for as affiliation invitation DTO."""

auth-api/src/auth_api/resources/v1/org.py

@@ -24,7 +24,7 @@
 from auth_api.models import Affiliation as AffiliationModel
 from auth_api.models import Org as OrgModel
 from auth_api.models.dataclass import Affiliation as AffiliationData
-from auth_api.models.dataclass import DeleteAffiliationRequest, SimpleOrgSearch
+from auth_api.models.dataclass import AffiliationSearchDetails, DeleteAffiliationRequest, SimpleOrgSearch
 from auth_api.models.org import OrgSearch  # noqa: I005; Not sure why isort doesn't like this
 from auth_api.schemas import InvitationSchema, MembershipSchema
 from auth_api.schemas import utils as schema_utils
@@ -382,11 +382,16 @@ def new_affiliation_search(org_id):
     """Get all affiliated entities for the given org by calling into Names and LEAR."""
     # get affiliation identifiers and the urls for the source data
     affiliations = AffiliationModel.find_affiliations_by_org_id(org_id)
-    affiliations_details_list = asyncio.run(AffiliationService.get_affiliation_details(affiliations, org_id))
+    search_details = AffiliationSearchDetails.from_request_args(request)
+    affiliations_details_list = asyncio.run(
+        AffiliationService.get_affiliation_details(affiliations, search_details, org_id)
+    )
     # Use orjson serializer here, it's quite a bit faster.
     response, status = (
         current_app.response_class(
-            response=orjson.dumps({"entities": affiliations_details_list}),  # pylint: disable=maybe-no-member
+            response=orjson.dumps(
+                {"entities": affiliations_details_list, "totalResults": len(affiliations_details_list)}
+            ),  # pylint: disable=maybe-no-member
             status=200,
             mimetype="application/json",
         ),

auth-api/src/auth_api/services/affiliation.py

@@ -14,7 +14,8 @@
 """Service for managing Affiliation data."""
 import datetime
 import re
-from typing import Dict, List
+from dataclasses import asdict
+from typing import Dict, List, Optional
 
 from flask import current_app
 from requests.exceptions import HTTPError
@@ -29,7 +30,7 @@
 from auth_api.models.contact_link import ContactLink
 from auth_api.models.dataclass import Activity
 from auth_api.models.dataclass import Affiliation as AffiliationData
-from auth_api.models.dataclass import DeleteAffiliationRequest
+from auth_api.models.dataclass import AffiliationSearchDetails, DeleteAffiliationRequest
 from auth_api.models.entity import Entity
 from auth_api.models.membership import Membership as MembershipModel
 from auth_api.schemas import AffiliationSchema
@@ -453,17 +454,24 @@ def _affiliation_details_url(affiliation: AffiliationModel) -> str:
         return current_app.config.get("LEAR_AFFILIATION_DETAILS_URL")
 
     @staticmethod
-    async def get_affiliation_details(affiliations: List[AffiliationModel], org_id) -> List:
+    async def get_affiliation_details(
+        affiliations: List[AffiliationModel], search_details: AffiliationSearchDetails, org_id
+    ) -> List:
         """Return affiliation details by calling the source api."""
         url_identifiers = {}  # i.e. turns into { url: [identifiers...] }
+        search_dict = asdict(search_details)
         for affiliation in affiliations:
             url = Affiliation._affiliation_details_url(affiliation)
-            url_identifiers.setdefault(url, [affiliation.entity.business_identifier]).append(
-                affiliation.entity.business_identifier
-            )
-
+            url_identifiers.setdefault(url, []).append(affiliation.entity.business_identifier)
         call_info = [
-            {"url": url, "payload": {"identifiers": identifiers}} for url, identifiers in url_identifiers.items()
+            {
+                "url": url,
+                "payload": {
+                    "identifiers": identifiers,
+                    **search_dict,
+                },
+            }
+            for url, identifiers in url_identifiers.items()
         ]
 
         token = RestService.get_service_account_token(
@@ -488,7 +496,7 @@ def sort_key(item):
             return combined
         except ServiceUnavailableException as err:
             logger.debug(err)
-            logger.debug("Failed to get affiliations details: %s", affiliations)
+            logger.debug("Failed to get affiliations details:  %s", affiliations)
             raise ServiceUnavailableException("Failed to get affiliation details") from err
 
     @staticmethod
@@ -560,7 +568,6 @@ def _get_nr_details(nr_number: str):
         except (HTTPError, ServiceUnavailableException) as e:
             logger.info(e)
             raise BusinessException(Error.DATA_NOT_FOUND, None) from e
-
         return get_nr_response.json()
 
     @staticmethod