Docs and logging

navapbc · May 30, 2024 · bba9a52 · bba9a52
1 parent 641ebd1
commit bba9a52
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/api/src/adapters/search/flask_opensearch.py b/api/src/adapters/search/flask_opensearch.py
@@ -21,7 +21,21 @@ def get_search_client(app: Flask) -> SearchClient:
 
 
 def with_search_client() -> Callable[[Callable[Concatenate[SearchClient, P], T]], Callable[P, T]]:
-    # TODO docs
+    """
+    Decorator for functions that need a search client.
+
+    This decorator will return the shared search client object which
+    has an internal connection pool that is shared.
+
+    Usage:
+        @with_search_client()
+        def foo(search_client: search.SearchClient):
+            ...
+
+        @with_search_client()
+        def bar(search_client: search.SearchClient, x: int, y: int):
+            ...
+    """
 
     def decorator(f: Callable[Concatenate[SearchClient, P], T]) -> Callable[P, T]:
         @wraps(f)

diff --git a/api/src/services/opportunities_v1/search_opportunities.py b/api/src/services/opportunities_v1/search_opportunities.py
@@ -121,10 +121,13 @@ def search_opportunities(
 
     search_request = _get_search_request(search_params)
 
-    response = search_client.search(
-        get_search_config().opportunity_search_index_alias, search_request
+    index_alias = get_search_config().opportunity_search_index_alias
+    logger.info(
+        "Querying search index alias %s", index_alias, extra={"search_index_alias": index_alias}
     )
 
+    response = search_client.search(index_alias, search_request)
+
     pagination_info = PaginationInfo(
         page_offset=search_params.pagination.page_offset,
         page_size=search_params.pagination.page_size,