WIP

Author: jamesgorrie

app/api/api_v1/routers/family.py

@@ -92,7 +92,7 @@ async def search_family(request: Request) -> list[FamilyReadDTO]:
 
     query_params = set_default_query_params(query_params)
 
-    VALID_PARAMS = ["q", "title", "summary", "geography", "status", "max_results"]
+    VALID_PARAMS = ["q", "title", "summary", "geographies", "status", "max_results"]
     validate_query_params(query_params, VALID_PARAMS)
 
     try:

app/model/family.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Optional, Union
+from typing import Optional
 
 from pydantic import BaseModel
 
@@ -12,7 +12,7 @@ class FamilyReadDTO(BaseModel):
     import_id: str
     title: str
     summary: str
-    geography: str
+    geographies: list[str]
     category: str
     status: str
     metadata: Json
@@ -41,7 +41,7 @@ class FamilyWriteDTO(BaseModel):
 
     title: str
     summary: str
-    geography: str
+    geographies: list[str]
     category: str
     metadata: Json
     collections: list[str]
@@ -60,7 +60,7 @@ class FamilyCreateDTO(BaseModel):
     import_id: Optional[str] = None
     title: str
     summary: str
-    geography: Union[str, list[str]]
+    geographies: list[str]
     category: str
     metadata: Json
     collections: list[str]

app/repository/family.py

@@ -22,7 +22,7 @@
 from db_client.models.organisation.users import Organisation
 from sqlalchemy import Column, and_
 from sqlalchemy import delete as db_delete
-from sqlalchemy import desc, func, or_
+from sqlalchemy import desc, or_
 from sqlalchemy import update as db_update
 from sqlalchemy.exc import NoResultFound, OperationalError
 from sqlalchemy.orm import Query, Session
@@ -34,30 +34,24 @@
 
 _LOGGER = logging.getLogger(__name__)
 
-FamilyGeoMetaOrg = Tuple[Family, str, FamilyMetadata, Corpus, Organisation]
+FamilyGeoMetaOrg = Tuple[Family, Geography, FamilyMetadata, Corpus, Organisation]
 
 
 def _get_query(db: Session) -> Query:
     # NOTE: SqlAlchemy will make a complete hash of query generation
     #       if columns are used in the query() call. Therefore, entire
     #       objects are returned.
-    geo_subquery = (
-        db.query(
-            func.min(Geography.value).label("value"),
-            FamilyGeography.family_import_id,
-        )
-        .join(FamilyGeography, FamilyGeography.geography_id == Geography.id)
-        .filter(FamilyGeography.family_import_id == Family.import_id)
-        .group_by(Geography.value, FamilyGeography.family_import_id)
-    ).subquery("geo_subquery")
-
     return (
-        db.query(Family, geo_subquery.c.value, FamilyMetadata, Corpus, Organisation)  # type: ignore
+        db.query(Family, Geography, FamilyMetadata, Corpus, Organisation)  # type: ignore
+        .join(FamilyGeography, FamilyGeography.family_import_id == Family.import_id)
+        .join(
+            Geography,
+            Geography.id == FamilyGeography.geography_id,
+        )
         .join(FamilyMetadata, FamilyMetadata.family_import_id == Family.import_id)
         .join(FamilyCorpus, FamilyCorpus.family_import_id == Family.import_id)
         .join(Corpus, Corpus.import_id == FamilyCorpus.corpus_import_id)
         .join(Organisation, Corpus.organisation_id == Organisation.id)
-        .filter(geo_subquery.c.family_import_id == Family.import_id)  # type: ignore
     )
 
 
@@ -72,7 +66,7 @@ def _family_to_dto(
         import_id=str(fam.import_id),
         title=str(fam.title),
         summary=str(fam.description),
-        geography=geo_value,
+        geographies=[str(geo_value.display_value)],
         category=str(fam.family_category),
         status=str(fam.family_status),
         metadata=metadata,
@@ -201,13 +195,9 @@ def search(
             term = f"%{escape_like(search_params['summary'])}%"
             search.append(Family.description.ilike(term))
 
-    if "geography" in search_params.keys():
-        term = cast(str, search_params["geography"])
-        search.append(
-            or_(
-                Geography.display_value == term.title(), Geography.value == term.upper()
-            )
-        )
+    if "geographies" in search_params.keys():
+        term = cast(str, search_params["geographies"])
+        search.append(Geography.display_value == term.title())
 
     if "status" in search_params.keys():
         term = cast(str, search_params["status"])

tests/integration_tests/family/test_search.py

@@ -7,6 +7,25 @@
 from tests.integration_tests.setup_db import setup_db
 
 
+def test_search_geographies(
+    client: TestClient, data_db: Session, superuser_header_token
+):
+    setup_db(data_db)
+    response = client.get(
+        "/api/v1/families/?geographies=zimbabwe",
+        headers=superuser_header_token,
+    )
+    assert response.status_code == status.HTTP_200_OK
+    data = response.json()
+    assert isinstance(data, list)
+
+    ids_found = set([f["import_id"] for f in data])
+    assert len(ids_found) == 1
+
+    # expected_ids = set(["A.0.0.2", "A.0.0.3"])
+    # assert ids_found.symmetric_difference(expected_ids) == set([])
+
+
 def test_search_family_super(
     client: TestClient, data_db: Session, superuser_header_token
 ):

tests/integration_tests/setup_db.py

@@ -31,7 +31,7 @@
         "import_id": "A.0.0.1",
         "title": "apple",
         "summary": "",
-        "geography": "Other",
+        "geographies": ["AFG"],
         "category": "UNFCCC",
         "status": "Created",
         "metadata": {
@@ -57,7 +57,7 @@
         "import_id": "A.0.0.2",
         "title": "apple orange banana",
         "summary": "apple",
-        "geography": "Other",
+        "geographies": ["ZWE"],
         "category": "UNFCCC",
         "status": "Created",
         "metadata": {
@@ -83,7 +83,7 @@
         "import_id": "A.0.0.3",
         "title": "title",
         "summary": "orange peas",
-        "geography": "Other",
+        "geographies": ["AFG"],
         "category": "UNFCCC",
         "status": "Created",
         "metadata": {"author": "CPR", "author_type": "Party"},
@@ -490,7 +490,7 @@ def _setup_family_data(
 
         geo_id = (
             test_db.query(Geography.id)
-            .filter(Geography.value == data["geography"])
+            .filter(Geography.value == data["geographies"][0])
             .scalar()
         )