Fix value mapping for bikesAllowed in GTFS GraphQL API

docs/GraphQL-Tutorial.md

@@ -41,6 +41,7 @@ GraphQL query in the left hand panel of the page:
             name
         }
         mode
+        bikesAllowed
     }
 }
 ```

src/ext-test/java/org/opentripplanner/ext/gtfsgraphqlapi/mapping/BikesAllowedMapperTest.java

@@ -0,0 +1,21 @@
+package org.opentripplanner.ext.gtfsgraphqlapi.mapping;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import java.util.Arrays;
+import org.junit.jupiter.api.Test;
+import org.opentripplanner.transit.model.network.BikeAccess;
+
+class BikesAllowedMapperTest {
+
+  @Test
+  void mapping() {
+    Arrays
+      .stream(BikeAccess.values())
+      .filter(ba -> ba != BikeAccess.UNKNOWN)
+      .forEach(d -> {
+        var mapped = BikesAllowedMapper.map(d);
+        assertEquals(d.toString(), mapped.toString());
+      });
+  }
+}

src/ext-test/resources/gtfsgraphqlapi/expectations/routes.json

@@ -9,7 +9,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "CARPOOL"
+        "mode" : "CARPOOL",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for SUBWAY",
@@ -19,7 +20,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "SUBWAY"
+        "mode" : "SUBWAY",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for BUS",
@@ -29,7 +31,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "BUS"
+        "mode" : "BUS",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for FERRY",
@@ -39,7 +42,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "FERRY"
+        "mode" : "FERRY",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for COACH",
@@ -49,7 +53,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "COACH"
+        "mode" : "COACH",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for TRAM",
@@ -59,7 +64,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "TRAM"
+        "mode" : "TRAM",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for CABLE_CAR",
@@ -69,7 +75,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "CABLE_CAR"
+        "mode" : "CABLE_CAR",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for FUNICULAR",
@@ -79,7 +86,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "FUNICULAR"
+        "mode" : "FUNICULAR",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for RAIL",
@@ -89,7 +97,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "RAIL"
+        "mode" : "RAIL",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for MONORAIL",
@@ -99,7 +108,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "MONORAIL"
+        "mode" : "MONORAIL",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for GONDOLA",
@@ -109,7 +119,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "GONDOLA"
+        "mode" : "GONDOLA",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for TROLLEYBUS",
@@ -119,7 +130,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "TROLLEYBUS"
+        "mode" : "TROLLEYBUS",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for AIRPLANE",
@@ -129,7 +141,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "AIRPLANE"
+        "mode" : "AIRPLANE",
+        "bikesAllowed" : "NO_INFORMATION"
       },
       {
         "longName" : "Long name for TAXI",
@@ -139,7 +152,8 @@
           "gtfsId" : "F:A1",
           "name" : "Agency Test"
         },
-        "mode" : "TAXI"
+        "mode" : "TAXI",
+        "bikesAllowed" : "NO_INFORMATION"
       }
     ]
   }

src/ext-test/resources/gtfsgraphqlapi/queries/routes.graphql

@@ -8,5 +8,6 @@
             name
         }
         mode
+        bikesAllowed
     }
 }

src/ext/java/org/opentripplanner/ext/gtfsgraphqlapi/datafetchers/RouteImpl.java

@@ -11,7 +11,9 @@
 import org.opentripplanner.ext.gtfsgraphqlapi.GraphQLUtils;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLDataFetchers;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes;
+import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLBikesAllowed;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLTransitMode;
+import org.opentripplanner.ext.gtfsgraphqlapi.mapping.BikesAllowedMapper;
 import org.opentripplanner.routing.alertpatch.EntitySelector;
 import org.opentripplanner.routing.alertpatch.TransitAlert;
 import org.opentripplanner.routing.services.TransitAlertService;
@@ -131,13 +133,8 @@ public DataFetcher<Iterable<TransitAlert>> alerts() {
   }
 
   @Override
-  public DataFetcher<String> bikesAllowed() {
-    return environment ->
-      switch (getSource(environment).getBikesAllowed()) {
-        case UNKNOWN -> "NO_INFORMATION";
-        case ALLOWED -> "POSSIBLE";
-        case NOT_ALLOWED -> "NOT_POSSIBLE";
-      };
+  public DataFetcher<GraphQLBikesAllowed> bikesAllowed() {
+    return environment -> BikesAllowedMapper.map(getSource(environment).getBikesAllowed());
   }
 
   @Override

src/ext/java/org/opentripplanner/ext/gtfsgraphqlapi/datafetchers/TripImpl.java

@@ -20,7 +20,9 @@
 import org.opentripplanner.ext.gtfsgraphqlapi.GraphQLUtils;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLDataFetchers;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes;
+import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLBikesAllowed;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLWheelchairBoarding;
+import org.opentripplanner.ext.gtfsgraphqlapi.mapping.BikesAllowedMapper;
 import org.opentripplanner.framework.time.ServiceDateUtils;
 import org.opentripplanner.model.Timetable;
 import org.opentripplanner.model.TripTimeOnDate;
@@ -165,13 +167,8 @@ public DataFetcher<TripTimeOnDate> arrivalStoptime() {
   }
 
   @Override
-  public DataFetcher<String> bikesAllowed() {
-    return environment ->
-      switch (getSource(environment).getBikesAllowed()) {
-        case UNKNOWN -> "NO_INFORMATION";
-        case ALLOWED -> "POSSIBLE";
-        case NOT_ALLOWED -> "NOT_POSSIBLE";
-      };
+  public DataFetcher<GraphQLBikesAllowed> bikesAllowed() {
+    return environment -> BikesAllowedMapper.map(getSource(environment).getBikesAllowed());
   }
 
   @Override

src/ext/java/org/opentripplanner/ext/gtfsgraphqlapi/generated/GraphQLDataFetchers.java

@@ -15,6 +15,7 @@
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLAlertCauseType;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLAlertEffectType;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLAlertSeverityLevelType;
+import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLBikesAllowed;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLInputField;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLRelativeDirection;
 import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLRoutingErrorCode;
@@ -309,9 +310,12 @@ public interface GraphQLDefaultFareProduct {
   }
 
   /**
-   * Departure row is a location, which lists departures of a certain pattern from a
-   * stop. Departure rows are identified with the pattern, so querying departure rows
-   * will return only departures from one stop per pattern
+   * Departure row is a combination of a pattern and a stop of that pattern.
+   *
+   * They are de-duplicated so for each pattern there will only be a single departure row.
+   *
+   * This is useful if you want to show a list of stop/pattern combinations but want each pattern to be
+   * listed only once.
    */
   public interface GraphQLDepartureRow {
     public DataFetcher<graphql.relay.Relay.ResolvedGlobalId> id();
@@ -789,7 +793,7 @@ public interface GraphQLRoute {
 
     public DataFetcher<Iterable<TransitAlert>> alerts();
 
-    public DataFetcher<String> bikesAllowed();
+    public DataFetcher<GraphQLBikesAllowed> bikesAllowed();
 
     public DataFetcher<String> color();
 
@@ -1015,7 +1019,7 @@ public interface GraphQLTrip {
 
     public DataFetcher<TripTimeOnDate> arrivalStoptime();
 
-    public DataFetcher<String> bikesAllowed();
+    public DataFetcher<GraphQLBikesAllowed> bikesAllowed();
 
     public DataFetcher<String> blockId();
 

src/ext/java/org/opentripplanner/ext/gtfsgraphqlapi/generated/graphql-codegen.yml

@@ -40,7 +40,7 @@ config:
     VehicleRentalStation: org.opentripplanner.service.vehiclerental.model.VehicleRentalStation#VehicleRentalStation
     RentalVehicle: org.opentripplanner.service.vehiclerental.model.VehicleRentalVehicle#VehicleRentalVehicle
     VehicleRentalUris: org.opentripplanner.service.vehiclerental.model.VehicleRentalStationUris#VehicleRentalStationUris
-    BikesAllowed: String
+    BikesAllowed: org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLBikesAllowed#GraphQLBikesAllowed
     BookingInfo: org.opentripplanner.model.BookingInfo
     BookingTime: org.opentripplanner.model.BookingTime
     CarPark: org.opentripplanner.routing.vehicle_parking.VehicleParking#VehicleParking

src/ext/java/org/opentripplanner/ext/gtfsgraphqlapi/mapping/BikesAllowedMapper.java

@@ -0,0 +1,17 @@
+package org.opentripplanner.ext.gtfsgraphqlapi.mapping;
+
+import javax.annotation.Nonnull;
+import org.opentripplanner.ext.gtfsgraphqlapi.generated.GraphQLTypes.GraphQLBikesAllowed;
+import org.opentripplanner.transit.model.network.BikeAccess;
+
+public class BikesAllowedMapper {
+
+  @Nonnull
+  public static GraphQLBikesAllowed map(@Nonnull BikeAccess bikesAllowed) {
+    return switch (bikesAllowed) {
+      case UNKNOWN -> GraphQLBikesAllowed.NO_INFORMATION;
+      case ALLOWED -> GraphQLBikesAllowed.ALLOWED;
+      case NOT_ALLOWED -> GraphQLBikesAllowed.NOT_ALLOWED;
+    };
+  }
+}