feat: add latest dataset features to the search endpoint (#1119)

Author: davidgamez

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

@@ -36,7 +36,9 @@ def from_orm(cls, dataset: Gtfsdataset | None) -> LatestDataset | None:
                 unique_error_count=latest_report.unique_error_count,
                 unique_warning_count=latest_report.unique_warning_count,
                 unique_info_count=latest_report.unique_info_count,
+                features=sorted([feature.name for feature in latest_report.features]) if latest_report.features else [],
             )
+
         return cls(
             id=dataset.stable_id,
             hosted_url=dataset.hosted_url,

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

@@ -1,8 +1,11 @@
 from feeds_gen.models.latest_dataset import LatestDataset
+from feeds_gen.models.latest_dataset_validation_report import LatestDatasetValidationReport
 from feeds_gen.models.search_feed_item_result import SearchFeedItemResult
 from feeds_gen.models.source_info import SourceInfo
 import pycountry
 
+from shared.database_gen.sqlacodegen_models import t_feedsearch
+
 
 class SearchFeedItemResultImpl(SearchFeedItemResult):
     """Implementation of the `SearchFeedItemResult` model.
@@ -16,7 +19,7 @@ class Config:
         from_attributes = True
 
     @classmethod
-    def from_orm_gtfs(cls, feed_search_row):
+    def from_orm_gtfs(cls, feed_search_row: t_feedsearch):
         """Create a model instance from a SQLAlchemy a GTFS row object."""
         return cls(
             id=feed_search_row.feed_stable_id,
@@ -47,6 +50,17 @@ def from_orm_gtfs(cls, feed_search_row):
                 service_date_range_start=feed_search_row.latest_dataset_service_date_range_start,
                 service_date_range_end=feed_search_row.latest_dataset_service_date_range_end,
                 agency_timezone=feed_search_row.latest_dataset_agency_timezone,
+                validation_report=LatestDatasetValidationReport(
+                    total_error=feed_search_row.latest_total_error,
+                    total_warning=feed_search_row.latest_total_warning,
+                    total_info=feed_search_row.latest_total_info,
+                    unique_error_count=feed_search_row.latest_unique_error_count,
+                    unique_warning_count=feed_search_row.latest_unique_warning_count,
+                    unique_info_count=feed_search_row.latest_unique_info_count,
+                    features=sorted([feature for feature in feed_search_row.latest_dataset_features])
+                    if feed_search_row.latest_dataset_features
+                    else [],
+                ),
             )
             if feed_search_row.latest_dataset_id
             else None,

api/src/shared/common/db_utils.py

@@ -83,7 +83,9 @@ def get_gtfs_feeds_query(
 
     if include_options_for_joinedload:
         feed_query = feed_query.options(
-            contains_eager(Gtfsfeed.gtfsdatasets).joinedload(Gtfsdataset.validation_reports),
+            contains_eager(Gtfsfeed.gtfsdatasets)
+            .joinedload(Gtfsdataset.validation_reports)
+            .joinedload(Validationreport.features),
             *get_joinedload_options(),
         ).order_by(Gtfsfeed.provider, Gtfsfeed.stable_id)
 

api/tests/test_data/test_datasets.json

@@ -177,7 +177,7 @@
   ],
   "features": [
     "Text-to-speech",
-    "Wheelchair accesibility",
+    "Wheelchair accessibility",
     "Route Colors",
     "Bike Allowed",
     "Translations",
@@ -194,7 +194,7 @@
     },
     {
       "validation_report_id": "dataset-1-report-1",
-      "feature_name": "Wheelchair accesibility"
+      "feature_name": "Wheelchair accessibility"
     },
     {
       "validation_report_id": "dataset-1-report-1",

api/tests/unittest/models/test_gtfs_feed_impl.py

@@ -172,6 +172,7 @@ def create_test_notice(notice_code: str, total_notices: int, severity: str):
             unique_error_count=3,
             unique_warning_count=4,
             unique_info_count=2,
+            features=["feature"],
         ),
         service_date_range_start=datetime(2024, 1, 1, 0, 0, 0, tzinfo=ZoneInfo("Canada/Atlantic")),
         service_date_range_end=datetime(2025, 1, 1, 0, 0, 0, tzinfo=ZoneInfo("Canada/Atlantic")),

api/tests/unittest/models/test_latest_dataset_impl.py

@@ -4,7 +4,7 @@
 
 from geoalchemy2 import WKTElement
 
-from shared.database_gen.sqlacodegen_models import Gtfsdataset, Feed, Validationreport
+from shared.database_gen.sqlacodegen_models import Gtfsdataset, Feed, Validationreport, Feature
 from feeds.impl.models.bounding_box_impl import BoundingBoxImpl
 from feeds.impl.models.latest_dataset_impl import LatestDatasetImpl
 
@@ -36,6 +36,7 @@ def test_from_orm(self):
                         unique_error_count=0,
                         unique_warning_count=0,
                         unique_info_count=0,
+                        features=[],
                     ),
                     Validationreport(
                         validator_version="1.2.0",
@@ -45,6 +46,7 @@ def test_from_orm(self):
                         unique_error_count=2,
                         unique_warning_count=1,
                         unique_info_count=1,
+                        features=[Feature(name="feature 1.2.0 1"), Feature(name="feature 1.2.0 2")],
                     ),
                     Validationreport(
                         validator_version="1.1.1",
@@ -54,6 +56,7 @@ def test_from_orm(self):
                         unique_error_count=1,
                         unique_warning_count=1,
                         unique_info_count=0,
+                        features=[Feature(name="feature 1.1.1 1"), Feature(name="feature 1.1.1 2")],
                     ),
                 ],
             )
@@ -74,6 +77,7 @@ def test_from_orm(self):
             service_date_range_end=datetime(2025, 1, 1, 0, 0, 0, tzinfo=ZoneInfo("Canada/Atlantic")),
             agency_timezone="Canada/Atlantic",
             validation_report={
+                "features": ["feature 1.2.0 1", "feature 1.2.0 2"],
                 "validator_version": "1.2.0",
                 "total_error": 3,
                 "total_info": 1,

api/tests/unittest/models/test_search_feed_item_result_impl.py

@@ -5,6 +5,7 @@
 
 from feeds.impl.models.search_feed_item_result_impl import SearchFeedItemResultImpl
 from feeds_gen.models.latest_dataset import LatestDataset
+from feeds_gen.models.latest_dataset_validation_report import LatestDatasetValidationReport
 from feeds_gen.models.location import Location
 from feeds_gen.models.source_info import SourceInfo
 
@@ -43,6 +44,13 @@ def __init__(self, **kwargs):
     latest_dataset_service_date_range_start="2030-09-29T00:00:00+00:00",
     latest_dataset_service_date_range_end="2031-09-29T00:00:00+00:00",
     latest_dataset_agency_timezone="Canada/Atlantic",
+    latest_total_error=1,
+    latest_total_warning=2,
+    latest_total_info=3,
+    latest_unique_error_count=1,
+    latest_unique_warning_count=2,
+    latest_unique_info_count=3,
+    latest_dataset_features=["feature1", "feature2"],
     external_ids=[],
     redirect_ids=[],
     feed_reference_ids=[],
@@ -86,6 +94,15 @@ def test_from_orm_gtfs(self):
                 service_date_range_start=item.latest_dataset_service_date_range_start,
                 service_date_range_end=item.latest_dataset_service_date_range_end,
                 agency_timezone=item.latest_dataset_agency_timezone,
+                validation_report=LatestDatasetValidationReport(
+                    total_error=item.latest_total_error,
+                    total_warning=item.latest_total_warning,
+                    total_info=item.latest_total_info,
+                    unique_error_count=item.latest_unique_error_count,
+                    unique_warning_count=item.latest_unique_warning_count,
+                    unique_info_count=item.latest_unique_info_count,
+                    features=item.latest_dataset_features,
+                ),
             ),
         )
         assert result == expected

docs/DatabaseCatalogAPI.yaml

@@ -778,6 +778,12 @@ components:
         validation_report:
           type: object
           properties:
+            features:
+              description: List of GTFS features associated to the dataset. More information, https://gtfs.org/getting-started/features/overview
+              type: array
+              items:
+                type: string
+              example: ["Shapes", "Headsigns", "Wheelchair Accessibility"]
             total_error:
               type: integer
               example: 10
@@ -1026,11 +1032,11 @@ components:
           example: 2023-07-10T22:06:00Z
           format: date-time
         features:
-          description: An array of features for this dataset.
+          description: List of GTFS features associated to the dataset. More information, https://gtfs.org/getting-started/features/overview
           type: array
           items:
             type: string
-            example: Fares_V1
+          example: ["Shapes", "Headsigns", "Wheelchair Accessibility"]
         validator_version:
           type: string
           example: 4.2.0

liquibase/changelog.xml

@@ -48,4 +48,6 @@
     <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. -->
+    <include file="changes/feat_993.sql" relativeToChangelogFile="true"/>
 </databaseChangeLog>