fix: HTTP 503 response for gbfs_feeds endpoint (#1206)

Author: davidgamez

api/src/shared/common/db_utils.py

@@ -448,7 +448,9 @@ def get_gbfs_feeds_query(
         .options(
             contains_eager(Gbfsfeed.gbfsversions).contains_eager(Gbfsversion.gbfsvalidationreports),
             contains_eager(Gbfsfeed.gbfsversions).joinedload(Gbfsversion.gbfsendpoints),
-            *get_joinedload_options(),
+            joinedload(Feed.locations),
+            joinedload(Feed.externalids),
+            joinedload(Feed.redirectingids).joinedload(Redirectingid.target),
         )
     )
     return query

api/src/shared/database/database.py

@@ -124,7 +124,7 @@ def with_db_session(func=None, db_url: str | None = None):
     def wrapper(*args, **kwargs):
         db_session = kwargs.get("db_session")
         if db_session is None:
-            db = Database(echo_sql=get_env_logging_level() == "DEBUG", feeds_database_url=db_url)
+            db = Database(echo_sql=get_env_logging_level() == logging.getLevelName("DEBUG"), feeds_database_url=db_url)
             with db.start_db_session() as session:
                 kwargs["db_session"] = session
                 return func(*args, **kwargs)

api/tests/integration/test_feeds_api.py

@@ -829,6 +829,7 @@ def test_gtfs_redirect(client):
         {"endpoint": "/v1/gtfs_rt_feeds", "hard_limit": 1000},
         {"endpoint": "/v1/gtfs_feeds/mdb-1/datasets", "hard_limit": 500},
         {"endpoint": "/v1/search", "hard_limit": 3500},
+        {"endpoint": "/v1/gbfs_feeds", "hard_limit": 500},
     ],
 )
 def test_hard_limits(client, monkeypatch, values):
@@ -841,7 +842,7 @@ def test_hard_limits(client, monkeypatch, values):
         headers=authHeaders,
         params={"limit": hard_limit + 1},
     )
-    assert response.status_code != 200
+    assert response.status_code == 422
 
 
 @pytest.mark.parametrize(

docs/DatabaseCatalogAPI.yaml

@@ -146,7 +146,7 @@ paths:
         - "beta"
       operationId: getGbfsFeeds
       parameters:
-        - $ref: "#/components/parameters/limit_query_param_gtfs_feeds_endpoint"
+        - $ref: "#/components/parameters/limit_query_param_gbfs_feeds_endpoint"
         - $ref: "#/components/parameters/offset"
         - $ref: "#/components/parameters/provider"
         - $ref: "#/components/parameters/producer_url"
@@ -1344,6 +1344,18 @@ components:
         maximum: 3500
         default: 3500
         example: 10
+
+    limit_query_param_gbfs_feeds_endpoint:
+      name: limit
+      in: query
+      description: The number of items to be returned.
+      required: False
+      schema:
+        type: integer
+        minimum: 0
+        maximum: 500
+        default: 500
+        example: 10
 
     offset:
       name: offset

liquibase/changelog.xml

@@ -60,4 +60,5 @@
     <!-- Materialized view updated. Used Feed.created_at field as timestamp. -->
     <include file="changes/feat_1082.sql" relativeToChangelogFile="true"/>
     <include file="changes/feat_1181.sql" relativeToChangelogFile="true"/>
+    <include file="changes/feat_1182.sql" relativeToChangelogFile="true"/>
 </databaseChangeLog>

liquibase/changes/feat_1182.sql

@@ -0,0 +1,19 @@
+-- This SQL script adds indexes that enhance the GBFS SQL queries
+
+CREATE INDEX IF NOT EXISTS idx_gbfsversion_feed_id
+  ON gbfsversion (feed_id);
+
+CREATE INDEX IF NOT EXISTS idx_redirectingid_source_id
+  ON redirectingid (source_id);
+
+CREATE INDEX IF NOT EXISTS idx_redirectingid_target_id
+  ON redirectingid (target_id);
+
+CREATE INDEX IF NOT EXISTS idx_externalid_feed_id
+  ON externalid (feed_id);
+
+CREATE INDEX IF NOT EXISTS idx_officialstatushistory_feed_id
+  ON officialstatushistory (feed_id);
+
+CREATE INDEX IF NOT EXISTS idx_gbfsendpoint_gv_id
+  ON gbfsendpoint (gbfs_version_id);

web-app/src/app/services/feeds/types.ts

@@ -712,6 +712,8 @@ export interface components {
     limit_query_param_datasets_endpoint?: number;
     /** @description The number of items to be returned. */
     limit_query_param_search_endpoint?: number;
+    /** @description The number of items to be returned. */
+    limit_query_param_gbfs_feeds_endpoint?: number;
     /** @description Offset of the first item to return. */
     offset?: number;
     /** @description General search query to match against transit provider, location, and feed name. */
@@ -848,7 +850,7 @@ export interface operations {
   getGbfsFeeds: {
     parameters: {
       query?: {
-        limit?: components['parameters']['limit_query_param_gtfs_feeds_endpoint'];
+        limit?: components['parameters']['limit_query_param_gbfs_feeds_endpoint'];
         offset?: components['parameters']['offset'];
         provider?: components['parameters']['provider'];
         producer_url?: components['parameters']['producer_url'];