feat: added versions filtering to search (#1162)

Author: cka-y

api/src/feeds/impl/models/search_feed_item_result_impl.py

@@ -80,6 +80,7 @@ def from_orm_gbfs(cls, feed_search_row):
             external_ids=feed_search_row.external_ids,
             provider=feed_search_row.provider,
             feed_contact_email=feed_search_row.feed_contact_email,
+            versions=feed_search_row.versions,
             source_info=SourceInfo(
                 producer_url=feed_search_row.producer_url,
                 authentication_type=(

api/src/feeds/impl/search_api_impl.py

@@ -2,7 +2,7 @@
 
 from sqlalchemy import func, select
 from sqlalchemy.orm import Query, Session
-
+from sqlalchemy.dialects.postgresql import array
 from shared.database.database import Database, with_db_session
 from shared.database.sql_functions.unaccent import unaccent
 from shared.database_gen.sqlacodegen_models import t_feedsearch
@@ -31,7 +31,9 @@ def get_parsed_search_tsquery(search_query: str) -> str:
         return func.plainto_tsquery("english", unaccent(parsed_query))
 
     @staticmethod
-    def add_search_query_filters(query, search_query, data_type, feed_id, status, is_official, features) -> Query:
+    def add_search_query_filters(
+        query, search_query, data_type, feed_id, status, is_official, features, version
+    ) -> Query:
         """
         Add filters to the search query.
         Filter values are trimmed and converted to lowercase.
@@ -58,6 +60,10 @@ def add_search_query_filters(query, search_query, data_type, feed_id, status, is
                 query = query.where(t_feedsearch.c.official.is_(True))
             else:
                 query = query.where(or_(t_feedsearch.c.official.is_(False), t_feedsearch.c.official.is_(None)))
+        if version:
+            versions_list = [v.strip().lower() for v in version.split(",") if v]
+            if versions_list:
+                query = query.where(t_feedsearch.c.versions.op("?|")(array(versions_list)))
         if search_query and len(search_query.strip()) > 0:
             query = query.filter(
                 t_feedsearch.c.document.op("@@")(SearchApiImpl.get_parsed_search_tsquery(search_query))
@@ -77,15 +83,16 @@ def create_count_search_query(
         feed_id: str,
         data_type: str,
         is_official: bool,
-        search_query: str,
         features,
+        version: str,
+        search_query: str,
     ) -> Query:
         """
         Create a search query for the database.
         """
         query = select(func.count(t_feedsearch.c.feed_id))
         return SearchApiImpl.add_search_query_filters(
-            query, search_query, data_type, feed_id, status, is_official, features
+            query, search_query, data_type, feed_id, status, is_official, features, version
         )
 
     @staticmethod
@@ -96,6 +103,7 @@ def create_search_query(
         is_official: bool,
         search_query: str,
         features: List[str],
+        version: str,
     ) -> Query:
         """
         Create a search query for the database.
@@ -109,7 +117,7 @@ def create_search_query(
             *feed_search_columns,
         )
         query = SearchApiImpl.add_search_query_filters(
-            query, search_query, data_type, feed_id, status, is_official, features
+            query, search_query, data_type, feed_id, status, is_official, features, version
         )
         return query.order_by(rank_expression.desc())
 
@@ -122,12 +130,13 @@ def search_feeds(
         feed_id: str,
         data_type: str,
         is_official: bool,
+        version: str,
         search_query: str,
-        features: List[str],
+        feature: List[str],
         db_session: "Session",
     ) -> SearchFeeds200Response:
         """Search feeds using full-text search on feed, location and provider's information."""
-        query = self.create_search_query(status, feed_id, data_type, is_official, search_query, features)
+        query = self.create_search_query(status, feed_id, data_type, is_official, search_query, feature, version)
         feed_rows = Database().select(
             session=db_session,
             query=query,
@@ -136,7 +145,9 @@ def search_feeds(
         )
         feed_total_count = Database().select(
             session=db_session,
-            query=self.create_count_search_query(status, feed_id, data_type, is_official, search_query, features),
+            query=self.create_count_search_query(
+                status, feed_id, data_type, is_official, feature, version, search_query
+            ),
         )
         if feed_rows is None or feed_total_count is None:
             return SearchFeeds200Response(

api/tests/integration/test_search_api.py

@@ -426,6 +426,50 @@ def test_search_filter_by_official_status(client: TestClient, values: dict):
     ), f"There should be {expected_count} feeds for official={values['official']}"
 
 
+@pytest.mark.parametrize(
+    "values",
+    [
+        {"versions": "1.0", "expected_count": 0},
+        {"versions": "2.3,3.0", "expected_count": 2},
+        {"versions": "3.0", "expected_count": 1},
+        {"versions": "2.3", "expected_count": 2},
+        {"versions": None, "expected_count": 16},
+    ],
+    ids=[
+        "Version 1.0",
+        "Versions 2.3 and 3.0",
+        "Version 3.0",
+        "Version 2.3",
+        "No version specified",
+    ],
+)
+def test_search_filter_by_versions(client: TestClient, values: dict):
+    """
+    Retrieve feeds with the version.
+    """
+    params = None
+    if values["versions"] is not None:
+        params = [
+            ("version", values["versions"]),
+        ]
+
+    headers = {
+        "Authentication": "special-key",
+    }
+    response = client.request(
+        "GET",
+        "/v1/search",
+        headers=headers,
+        params=params,
+    )
+    # Parse the response body into a Python object
+    response_body = SearchFeeds200Response.parse_obj(response.json())
+    expected_count = values["expected_count"]
+    assert (
+        response_body.total == expected_count
+    ), f"There should be {expected_count} feeds for versions={values['versions']}"
+
+
 @pytest.mark.parametrize(
     "values",
     [

docs/DatabaseCatalogAPI.yaml

@@ -334,6 +334,7 @@ paths:
         - $ref: "#/components/parameters/feed_id_query_param"
         - $ref: "#/components/parameters/data_type_query_param"
         - $ref: "#/components/parameters/is_official_query_param"
+        - $ref: "#/components/parameters/version_query_param"
         - $ref: "#/components/parameters/search_text_query_param"
         - $ref: "#/components/parameters/feature"
       security:
@@ -713,6 +714,12 @@ components:
                 * sa - service alerts
 #              Have to put the enum inline because of a bug in openapi-generator
 #              $ref: "#/components/schemas/EntityTypes"
+        versions:
+          type: array
+          items:
+            type: string
+            example: 2.3
+          description: The supported versions of the GBFS feed.
         feed_references:
           description:
             A list of the GTFS feeds that the real time source is associated with, represented by their MDB source IDs.
@@ -1335,6 +1342,15 @@ components:
       schema:
         type: string
 
+    version_query_param:
+      name: version
+      in: query
+      description: Comma separated list of GBFS versions to filter by.
+      required: False
+      schema:
+        type: string
+        example: 2.0,2.1
+
     data_type_query_param:
       name: data_type
       in: query

liquibase/changelog.xml

@@ -48,10 +48,12 @@
     <include file="changes/feat_1055.sql" relativeToChangelogFile="true"/>
     <include file="changes/feat_1041.sql" relativeToChangelogFile="true"/>
     <include file="changes/feat_997.sql" relativeToChangelogFile="true"/>
-<!-- Materialized view updated. Added features and totals. -->
+    <!-- Materialized view updated. Added features and totals. -->
     <include file="changes/feat_993.sql" relativeToChangelogFile="true"/>
     <!-- Materialized view updated. Used Feed.official field as official status. -->
     <include file="changes/feat_1083.sql" relativeToChangelogFile="true"/>
     <include file="changes/feat_1132.sql" relativeToChangelogFile="true"/>
     <include file="changes/feat_1124.sql" relativeToChangelogFile="true"/>
+    <!-- Materialized view updated. Added versions of GBFS feeds-->
+    <include file="changes/feat_1118.sql" relativeToChangelogFile="true"/>
 </databaseChangeLog>