feat: Dynamically allow and pass WorkSearchScheme fields as query parameters to the search endpoint, including a new test.

Author: RayBB

openlibrary/fastapi/search.py

@@ -5,7 +5,7 @@
 
 from fastapi import APIRouter, Depends, Query, Request
 from fastapi.responses import JSONResponse
-from pydantic import BaseModel
+from pydantic import BaseModel, create_model
 
 from openlibrary.plugins.worksearch.code import (
     default_spellcheck_count,
@@ -40,6 +40,20 @@ def pagination(
     return Pagination(limit=limit, offset=offset, page=page)
 
 
+field_names = set(WorkSearchScheme.all_fields) | set(
+    # WorkSearchScheme.field_name_map.keys()
+    # Temporarily commented out because field names can't start with underscores but we have _ia_collection
+)
+
+
+# Dynamically create the model
+AllAllowedParams = create_model(
+    'AllAllowedParams',
+    __base__=BaseModel,
+    **{name: (str | None, Query(None)) for name in field_names},
+)
+
+
 @router.get("/search.json", response_class=JSONResponse)
 async def search_json(  # noqa: PLR0913
     request: Request,
@@ -51,8 +65,12 @@ async def search_json(  # noqa: PLR0913
     first_publish_year: ListQuery,
     publisher_facet: ListQuery,
     language: ListQuery,
-    public_scan_b: ListQuery,  # tbd if this should actually be a query
+    public_scan_b: ListQuery,  # tbd if this should actually be a list
     pagination: Annotated[Pagination, Depends(pagination)],
+    all_allowed_params: Annotated[  # type: ignore[valid-type]
+        AllAllowedParams,
+        Depends(),
+    ],
     q: str | None = Query("", description="The search query."),
     sort: str | None = Query(None, description="The sort order of results."),
     fields: str | None = Query(None, description="The fields to return."),
@@ -73,9 +91,7 @@ async def search_json(  # noqa: PLR0913
         query = json.loads(query_str)
     else:
         query = {"q": q, "page": pagination.page, "limit": pagination.limit}
-        query.update(
-            dict(request.query_params)
-        )  # This is a hack until we define all the params we expect in the route
+        query.update({k: v for k, v in all_allowed_params.dict().items() if v is not None})  # type: ignore[attr-defined]
         query.update(
             {
                 "author_key": author_key,

openlibrary/tests/fastapi/test_search.py

@@ -175,3 +175,25 @@ def test_pagination_validation_errors(self, client, mock_work_search, params):
 
         # Should return a validation error
         assert response.status_code == 422
+
+    def test_query_params_passed_down(self, client, mock_work_search):
+        """Test that arbitrary query parameters like osp_count are passed down correctly."""
+        mock_work_search.return_value = {
+            'numFound': 1,
+            'start': 0,
+            'docs': [{'key': '/works/OL1W', 'title': 'Test Work'}],
+        }
+
+        # Make a request with osp_count parameter
+        response = search(client, q='test', osp_count='5')
+
+        assert response.status_code == 200
+
+        # Verify work_search_async was called
+        mock_work_search.assert_called_once()
+        call_args = mock_work_search.call_args
+
+        # The query dict should contain the osp_count parameter
+        query_arg = call_args[0][0]  # First positional argument
+        assert 'osp_count' in query_arg
+        assert query_arg['osp_count'] == '5'