refactor: addressed feedback

Author: jirhiker

api/observation.py

@@ -110,7 +110,10 @@ def get_groundwater_level_observations(
         sql = sql.where(Observation.observation_datetime <= end_time)
 
     sql = order_sort_filter(sql, Observation, sort, order, filter_)
-    sql = sql.order_by(Observation.observation_datetime.desc())
+
+    if not order:
+        sql = sql.order_by(Observation.observation_datetime.desc())
+
     return paginate(query=sql, conn=session)
 
 

api/search.py

@@ -16,7 +16,11 @@
 from fastapi import APIRouter, Depends
 from sqlalchemy import select
 from sqlalchemy.orm import Session
+from api.pagination import CustomPage
+from fastapi_pagination import paginate
+from fastapi_pagination.utils import disable_installed_extensions_check
 
+from core.dependencies import session_dependency
 from db import (
     Contact,
     Email,
@@ -27,12 +31,13 @@
     AssetThingAssociation,
     search,
 )
-from db.engine import get_db_session
 
+
+disable_installed_extensions_check()
 router = APIRouter(prefix="/search", tags=["search"])
 
 
-def _get_contact_results(session: Session, q: str) -> list[dict]:
+def _get_contact_results(session: Session, q: str, limit: int) -> list[dict]:
     vector = (
         Contact.search_vector
         | Email.search_vector
@@ -41,7 +46,8 @@ def _get_contact_results(session: Session, q: str) -> list[dict]:
     )
 
     query = search(
-        select(Contact).join(Email).join(Phone).join(Address), q, vector=vector
+        select(Contact).join(Email).join(Phone).join(Address), q, vector=vector,
+        limit= limit
     )
     contacts = session.scalars(query).all()
     results = [
@@ -62,13 +68,15 @@ def _get_contact_results(session: Session, q: str) -> list[dict]:
     return results
 
 
-def _get_thing_results(session: Session, q: str) -> list[dict]:
+def _get_thing_results(session: Session, q: str, limit: int) -> list[dict]:
     vector = Thing.search_vector
     water_well_query = search(
-        select(Thing).where(Thing.thing_type == "water well"), q, vector=vector
+        select(Thing).where(Thing.thing_type == "water well"), q, vector=vector,
+        limit=limit
     )
     spring_well_query = search(
-        select(Thing).where(Thing.thing_type == "spring"), q, vector=vector
+        select(Thing).where(Thing.thing_type == "spring"), q, vector=vector,
+        limit=limit
     )
 
     wells = session.scalars(water_well_query).all()
@@ -117,10 +125,11 @@ def make_spring_response(thing: Thing) -> dict:
     ]
 
 
-def _get_asset_results(session: Session, q: str) -> list[dict]:
+def _get_asset_results(session: Session, q: str, limit: int) -> list[dict]:
     vector = Asset.search_vector
     query = search(
-        select(Asset).join(AssetThingAssociation).join(Thing), q, vector=vector
+        select(Asset).join(AssetThingAssociation).join(Thing), q, vector=vector,
+        limit=limit
     )
 
     assets = session.scalars(query).all()
@@ -143,16 +152,17 @@ def _get_asset_results(session: Session, q: str) -> list[dict]:
 
 
 @router.get("")
-def search_api(q: str, session: Session = Depends(get_db_session)):
+def search_api(session: session_dependency, q: str, limit: int=25, ) -> CustomPage[dict]:
     """
     Search endpoint for the collaborative network.
     """
 
-    results = _get_contact_results(session, q)
-    results.extend(_get_thing_results(session, q))
-    results.extend(_get_asset_results(session, q))
+    results = _get_contact_results(session, q, limit)
+    results.extend(_get_thing_results(session, q, limit))
+    results.extend(_get_asset_results(session, q, limit))
 
-    return {"items": results, "total": len(results)}
+    return paginate(results)
+    # return {"items": results, "total": len(results)}
 
 
 # ============= EOF =============================================

core/dependencies.py

@@ -24,15 +24,24 @@
 session_dependency = Annotated[Session, Depends(get_db_session)]
 
 # authentication functions
-# well_user_function = authenticated(permissions=["", "well:write"])
+
+# Admin, can do everything Editor and Viewer can do
+# + create new objects
 admin_function = authenticated(permissions=["Admin"])
+
+# Editor can do everything Viewer can do
+# + edit existing objects
 editor_function = authenticated(permissions=["Editor"])
+
+# Viewer can view all "global" entities Location, Sample, Group, Lexicon, etc
 viewer_function = authenticated(permissions=["Viewer"])
 
+# AMP specific permissions
 amp_admin_function = authenticated(permissions=["AMPAdmin"])
 amp_editor_function = authenticated(permissions=["AMPEditor"])
 amp_viewer_function = authenticated(permissions=["AMPViewer"])
 
+# for testing
 no_permission_function = authenticated(permissions=["NoPermission"])
 
 

db/__init__.py

@@ -71,7 +71,7 @@ def adder(session, table, model, user=None, **kwargs):
     return obj
 
 
-def search(query, search_query, vector=None, regconfig=None, sort=True):
+def search(query, search_query, vector=None, regconfig=None, sort=True, limit=None):
     if not search_query.strip():
         return query
 
@@ -95,6 +95,9 @@ def search(query, search_query, vector=None, regconfig=None, sort=True):
             )
         )
 
+    if limit:
+        query = query.limit(limit)
+
     return query.params(term=search_query)
 
 

services/query_helper.py

@@ -121,7 +121,7 @@ def simple_all_getter(session, table) -> list[object]:
     return session.scalars(sql).all()
 
 
-def order_sort_filter(sql, table, sort, order, filter_) -> Select[Any]:
+def order_sort_filter(sql: Select[Any], table: DeclarativeBase, sort:str, order:str, filter_:str) -> Select[Any]:
     if order:
         if not sort:
             raise ValueError(