feat: add gbfs endpoint to the GBFSVersion entity (#1163)

Author: davidgamez

functions-python/gbfs_validator/src/gbfs_data_processor.py

@@ -118,6 +118,13 @@ def extract_gbfs_endpoints(
             except AttributeError:
                 language = None
             endpoints += GBFSEndpoint.from_dict(feed_match.value, language)
+
+        # If the autodiscovery endpoint is not listed then add it
+        if not any(endpoint.name == "gbfs" for endpoint in endpoints):
+            endpoints += GBFSEndpoint.from_dict(
+                [{"name": "gbfs", "url": gbfs_json_url}], None
+            )
+
         unique_endpoints = list(
             {
                 f"{endpoint.name}, {endpoint.language or ''}": endpoint
@@ -277,9 +284,9 @@ def update_or_create_gbfs_endpoint(
         features: List[str],
     ) -> Gbfsendpoint:
         """Update or create a GBFS endpoint entity."""
-        formatted_id = (
-            f"{self.stable_id}_{version}_{endpoint.name}_{endpoint.language or ''}"
-        )
+        formatted_id = f"{self.stable_id}_{version}_{endpoint.name}"
+        if endpoint.language:
+            formatted_id += f"_{endpoint.language}"
         gbfs_endpoint_orm = (
             db_session.query(Gbfsendpoint)
             .filter(Gbfsendpoint.id == formatted_id)

functions-python/gbfs_validator/tests/test_gbfs_data_processor.py

@@ -243,5 +243,10 @@ def test_fetch_gbfs_files(
             # Validate versions
             self.assertEqual(len(gbfs_feed.gbfsversions), 2)
             versions = [version.version for version in gbfs_feed.gbfsversions]
+            # Validate that autodiscovery url endpoint is added to all versions
+            for gbfs_version in gbfs_feed.gbfsversions:
+                assert any(
+                    endpoint.name == "gbfs" for endpoint in gbfs_version.gbfsendpoints
+                )
             self.assertIn("2.2", versions)
             self.assertIn("2.1", versions)

liquibase/changelog.xml

@@ -53,4 +53,5 @@
     <!-- 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"/>
 </databaseChangeLog>

liquibase/changes/feat_1124.sql

@@ -0,0 +1,17 @@
+-- Insert a GbfsEndpoint row to GbfsVersions that miss the gbfs(autodiscovery) endpoint
+INSERT INTO GbfsEndpoint (id, gbfs_version_id, url, name, is_feature)
+SELECT 
+    Feed.stable_id || '_' || GbfsVersion.version AS id,
+    GbfsVersion.id AS gbfs_version_id,
+    GbfsVersion.url AS url,
+    'gbfs' AS name,
+    false AS is_feature -- gbfs file is not a feature, see https://github.com/MobilityData/mobility-feed-api/issues/1125
+FROM GbfsVersion
+JOIN GbfsFeed ON GbfsVersion.feed_id = GbfsFeed.id
+JOIN Feed ON GbfsFeed.id = Feed.id
+WHERE NOT EXISTS (
+    SELECT 1
+    FROM GbfsEndpoint
+    WHERE GbfsEndpoint.gbfs_version_id = GbfsVersion.id
+      AND GbfsEndpoint.name = 'gbfs'
+);