Add query for cancelled trips to GTFS GraphQL API

src/main/java/org/opentripplanner/apis/gtfs/GtfsGraphQLIndex.java

@@ -38,6 +38,7 @@
 import org.opentripplanner.apis.gtfs.datafetchers.ContactInfoImpl;
 import org.opentripplanner.apis.gtfs.datafetchers.CoordinatesImpl;
 import org.opentripplanner.apis.gtfs.datafetchers.CurrencyImpl;
+import org.opentripplanner.apis.gtfs.datafetchers.DatedTripImpl;
 import org.opentripplanner.apis.gtfs.datafetchers.DefaultFareProductImpl;
 import org.opentripplanner.apis.gtfs.datafetchers.DepartureRowImpl;
 import org.opentripplanner.apis.gtfs.datafetchers.FareProductTypeResolver;
@@ -170,6 +171,7 @@ protected static GraphQLSchema buildSchema() {
         .type(typeWiring.build(CurrencyImpl.class))
         .type(typeWiring.build(FareProductUseImpl.class))
         .type(typeWiring.build(DefaultFareProductImpl.class))
+        .type(typeWiring.build(DatedTripImpl.class))
         .build();
       SchemaGenerator schemaGenerator = new SchemaGenerator();
       return schemaGenerator.makeExecutableSchema(typeRegistry, runtimeWiring);

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/DatedTripImpl.java

@@ -0,0 +1,37 @@
+package org.opentripplanner.apis.gtfs.datafetchers;
+
+import graphql.relay.Relay;
+import graphql.schema.DataFetcher;
+import graphql.schema.DataFetchingEnvironment;
+import org.opentripplanner.api.mapping.LocalDateMapper;
+import org.opentripplanner.apis.gtfs.generated.GraphQLDataFetchers;
+import org.opentripplanner.transit.model.timetable.DatedTrip;
+import org.opentripplanner.transit.model.timetable.Trip;
+
+public class DatedTripImpl implements GraphQLDataFetchers.GraphQLDatedTrip {
+
+  @Override
+  public DataFetcher<String> date() {
+    return env -> LocalDateMapper.mapToApi(getSource(env).serviceDate());
+  }
+
+  @Override
+  public DataFetcher<Trip> trip() {
+    return env -> getSource(env).trip();
+  }
+
+  @Override
+  public DataFetcher<Relay.ResolvedGlobalId> id() {
+    return env ->
+      new Relay.ResolvedGlobalId(
+        "DatedTrip",
+        getSource(env).trip().getId().toString() +
+        ';' +
+        LocalDateMapper.mapToApi(getSource(env).serviceDate())
+      );
+  }
+
+  private DatedTrip getSource(DataFetchingEnvironment environment) {
+    return environment.getSource();
+  }
+}

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/NodeTypeResolver.java

@@ -20,6 +20,7 @@
 import org.opentripplanner.transit.model.organization.Agency;
 import org.opentripplanner.transit.model.site.RegularStop;
 import org.opentripplanner.transit.model.site.Station;
+import org.opentripplanner.transit.model.timetable.DatedTrip;
 import org.opentripplanner.transit.model.timetable.Trip;
 
 public class NodeTypeResolver implements TypeResolver {
@@ -85,6 +86,9 @@ public GraphQLObjectType getType(TypeResolutionEnvironment environment) {
     if (o instanceof Trip) {
       return schema.getObjectType("Trip");
     }
+    if (o instanceof DatedTrip) {
+      return schema.getObjectType("DatedTrip");
+    }
     return null;
   }
 

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/QueryTypeImpl.java

@@ -13,6 +13,7 @@
 import graphql.schema.DataFetcher;
 import graphql.schema.DataFetchingEnvironment;
 import graphql.schema.DataFetchingEnvironmentImpl;
+import java.time.LocalDate;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Collections;
@@ -63,6 +64,7 @@
 import org.opentripplanner.transit.model.site.RegularStop;
 import org.opentripplanner.transit.model.site.Station;
 import org.opentripplanner.transit.model.site.StopLocation;
+import org.opentripplanner.transit.model.timetable.DatedTrip;
 import org.opentripplanner.transit.model.timetable.Trip;
 import org.opentripplanner.transit.service.TransitService;
 import org.opentripplanner.updater.GtfsRealtimeFuzzyTripMatcher;
@@ -422,6 +424,12 @@ public DataFetcher<Object> node() {
 
             return new PlaceAtDistance(place, Double.parseDouble(parts[0]));
           }
+        case "DatedTrip":
+          {
+            String[] parts = id.split(";");
+            var trip = transitService.getTripForId(FeedScopedId.parse(parts[0]));
+            return new DatedTrip(trip, LocalDate.parse(parts[1]));
+          }
         case "Route":
           return transitService.getRouteForId(FeedScopedId.parse(id));
         case "Stop":
@@ -787,6 +795,18 @@ public DataFetcher<Iterable<Trip>> trips() {
     };
   }
 
+  @Override
+  public DataFetcher<Connection<DatedTrip>> cancelledTrips() {
+    return environment -> {
+      var args = new GraphQLTypes.GraphQLQueryTypeCancelledTripsArgs(environment.getArguments());
+      var datedTrips = getTransitService(environment)
+        .getCancelledTrips(args.getGraphQLFeeds())
+        .stream()
+        .collect(Collectors.toList());
+      return new SimpleListConnection<>(datedTrips).get(environment);
+    };
+  }
+
   @Override
   public DataFetcher<VehicleParking> vehicleParking() {
     return environment -> {

src/main/java/org/opentripplanner/apis/gtfs/generated/GraphQLDataFetchers.java

@@ -20,7 +20,11 @@
 import org.opentripplanner.apis.gtfs.generated.GraphQLTypes.GraphQLRoutingErrorCode;
 import org.opentripplanner.apis.gtfs.generated.GraphQLTypes.GraphQLTransitMode;
 import org.opentripplanner.apis.gtfs.model.RideHailingProvider;
+import org.opentripplanner.apis.gtfs.model.RouteTypeModel;
+import org.opentripplanner.apis.gtfs.model.StopOnRouteModel;
+import org.opentripplanner.apis.gtfs.model.StopOnTripModel;
 import org.opentripplanner.apis.gtfs.model.StopPosition;
+import org.opentripplanner.apis.gtfs.model.UnknownModel;
 import org.opentripplanner.ext.fares.model.FareRuleSet;
 import org.opentripplanner.ext.ridehailing.model.RideEstimate;
 import org.opentripplanner.model.StopTimesInPattern;
@@ -55,6 +59,7 @@
 import org.opentripplanner.transit.model.network.Route;
 import org.opentripplanner.transit.model.network.TripPattern;
 import org.opentripplanner.transit.model.organization.Agency;
+import org.opentripplanner.transit.model.timetable.DatedTrip;
 import org.opentripplanner.transit.model.timetable.Trip;
 
 public class GraphQLDataFetchers {
@@ -293,6 +298,29 @@ public interface GraphQLCurrency {
     public DataFetcher<Integer> digits();
   }
 
+  /** Trip on a specific date */
+  public interface GraphQLDatedTrip {
+    public DataFetcher<String> date();
+
+    public DataFetcher<graphql.relay.Relay.ResolvedGlobalId> id();
+
+    public DataFetcher<Trip> trip();
+  }
+
+  /** A connection to a list of dated trips */
+  public interface GraphQLDatedTripConnection {
+    public DataFetcher<Iterable<Edge<DatedTrip>>> edges();
+
+    public DataFetcher<Object> pageInfo();
+  }
+
+  /** An edge for DatedTrip connection */
+  public interface GraphQLDatedTripEdge {
+    public DataFetcher<String> cursor();
+
+    public DataFetcher<DatedTrip> node();
+  }
+
   /**
    * The standard case of a fare product: it only has a single price to be paid by the passenger
    * and no discounts are applied.
@@ -665,6 +693,8 @@ public interface GraphQLQueryType {
 
     public DataFetcher<Iterable<TripTimeOnDate>> cancelledTripTimes();
 
+    public DataFetcher<Connection<DatedTrip>> cancelledTrips();
+
     public DataFetcher<VehicleParking> carPark();
 
     public DataFetcher<Iterable<VehicleParking>> carParks();

src/main/java/org/opentripplanner/apis/gtfs/generated/GraphQLTypes.java

@@ -1,6 +1,7 @@
 // THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 package org.opentripplanner.apis.gtfs.generated;
 
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
@@ -1205,6 +1206,65 @@ public void setGraphQLTrips(List<String> trips) {
     }
   }
 
+  public static class GraphQLQueryTypeCancelledTripsArgs {
+
+    private String after;
+    private String before;
+    private List<String> feeds;
+    private Integer first;
+    private Integer last;
+
+    public GraphQLQueryTypeCancelledTripsArgs(Map<String, Object> args) {
+      if (args != null) {
+        this.after = (String) args.get("after");
+        this.before = (String) args.get("before");
+        this.feeds = (List<String>) args.get("feeds");
+        this.first = (Integer) args.get("first");
+        this.last = (Integer) args.get("last");
+      }
+    }
+
+    public String getGraphQLAfter() {
+      return this.after;
+    }
+
+    public String getGraphQLBefore() {
+      return this.before;
+    }
+
+    public List<String> getGraphQLFeeds() {
+      return this.feeds;
+    }
+
+    public Integer getGraphQLFirst() {
+      return this.first;
+    }
+
+    public Integer getGraphQLLast() {
+      return this.last;
+    }
+
+    public void setGraphQLAfter(String after) {
+      this.after = after;
+    }
+
+    public void setGraphQLBefore(String before) {
+      this.before = before;
+    }
+
+    public void setGraphQLFeeds(List<String> feeds) {
+      this.feeds = feeds;
+    }
+
+    public void setGraphQLFirst(Integer first) {
+      this.first = first;
+    }
+
+    public void setGraphQLLast(Integer last) {
+      this.last = last;
+    }
+  }
+
   public static class GraphQLQueryTypeCarParkArgs {
 
     private String id;

src/main/java/org/opentripplanner/apis/gtfs/generated/graphql-codegen.yml

@@ -47,6 +47,9 @@ config:
     ContactInfo: org.opentripplanner.transit.model.organization.ContactInfo
     Cluster: Object
     Coordinates: org.locationtech.jts.geom.Coordinate#Coordinate
+    DatedTrip: org.opentripplanner.transit.model.timetable.DatedTrip#DatedTrip
+    DatedTripConnection: graphql.relay.Connection#Connection<DatedTrip>
+    DatedTripEdge: graphql.relay.Edge#Edge<DatedTrip>
     debugOutput: org.opentripplanner.api.resource.DebugOutput#DebugOutput
     DepartureRow: org.opentripplanner.routing.graphfinder.PatternAtStop#PatternAtStop
     elevationProfileComponent: org.opentripplanner.model.plan.ElevationProfile.Step

src/main/java/org/opentripplanner/transit/model/timetable/DatedTrip.java

@@ -0,0 +1,8 @@
+package org.opentripplanner.transit.model.timetable;
+
+import java.time.LocalDate;
+
+/**
+ * Class which represents a trin on a specific date
+ */
+public record DatedTrip(Trip trip, LocalDate serviceDate) {}

src/main/java/org/opentripplanner/transit/service/DefaultTransitService.java

@@ -8,7 +8,9 @@
 import java.time.LocalDate;
 import java.time.ZoneId;
 import java.time.ZonedDateTime;
+import java.util.ArrayList;
 import java.util.Collection;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -46,6 +48,8 @@
 import org.opentripplanner.transit.model.site.Station;
 import org.opentripplanner.transit.model.site.StopLocation;
 import org.opentripplanner.transit.model.site.StopLocationsGroup;
+import org.opentripplanner.transit.model.timetable.DatedTrip;
+import org.opentripplanner.transit.model.timetable.RealTimeState;
 import org.opentripplanner.transit.model.timetable.Trip;
 import org.opentripplanner.transit.model.timetable.TripIdAndServiceDate;
 import org.opentripplanner.transit.model.timetable.TripOnServiceDate;
@@ -247,6 +251,59 @@ public Trip getTripForId(FeedScopedId id) {
     return this.transitModelIndex.getTripForId().get(id);
   }
 
+  @Override
+  public Collection<DatedTrip> getCancelledTrips(List<String> feeds) {
+    OTPRequestTimeoutException.checkForTimeout();
+    List<DatedTrip> cancelledTrips = new ArrayList<>();
+    Map<Trip, Integer> departures = new HashMap<>();
+
+    var timetableSnapshot = lazyGetTimeTableSnapShot();
+    if (timetableSnapshot == null) {
+      return cancelledTrips;
+    }
+    var calendarService = getCalendarService();
+    var patternMap = transitModelIndex.getPatternForTrip();
+    var trips = transitModelIndex.getTripForId();
+
+    for (Map.Entry<FeedScopedId, Trip> entry : trips.entrySet()) {
+      var trip = entry.getValue();
+      if (feeds != null && !feeds.contains(trip.getId().getFeedId())) {
+        continue;
+      }
+      Set<LocalDate> serviceDates = calendarService.getServiceDatesForServiceId(
+        trip.getServiceId()
+      );
+      var pattern = patternMap.get(trip);
+      for (LocalDate date : serviceDates) {
+        var timetable = timetableSnapshot.resolve(pattern, date);
+        var tripTimes = timetable.getTripTimes(trip);
+        if (tripTimes.getRealTimeState() == RealTimeState.CANCELED) { // use UPDATED for faked testing
+          cancelledTrips.add(new DatedTrip(trip, date));
+          // store departure time from first stop
+          departures.put(trip, tripTimes.sortIndex());
+        }
+      }
+    }
+    cancelledTrips.sort((t1, t2) -> {
+      if (t1.serviceDate().isBefore(t2.serviceDate())) {
+        return -1;
+      } else if (t2.serviceDate().isBefore(t1.serviceDate())) {
+        return 1;
+      }
+      var departure1 = departures.get(t1.trip());
+      var departure2 = departures.get(t2.trip());
+      if (departure1 < departure2) {
+        return -1;
+      } else if (departure1 > departure2) {
+        return 1;
+      } else {
+        // identical departure day and time, so sort by unique feedscope id
+        return t1.trip().getId().compareTo(t2.trip().getId());
+      }
+    });
+    return cancelledTrips;
+  }
+
   @Override
   public Collection<Trip> getAllTrips() {
     OTPRequestTimeoutException.checkForTimeout();

src/main/java/org/opentripplanner/transit/service/TransitService.java

@@ -38,6 +38,7 @@
 import org.opentripplanner.transit.model.site.Station;
 import org.opentripplanner.transit.model.site.StopLocation;
 import org.opentripplanner.transit.model.site.StopLocationsGroup;
+import org.opentripplanner.transit.model.timetable.DatedTrip;
 import org.opentripplanner.transit.model.timetable.Trip;
 import org.opentripplanner.transit.model.timetable.TripIdAndServiceDate;
 import org.opentripplanner.transit.model.timetable.TripOnServiceDate;
@@ -108,6 +109,8 @@ public interface TransitService {
 
   Collection<Trip> getAllTrips();
 
+  Collection<DatedTrip> getCancelledTrips(List<String> feeds);
+
   Collection<Route> getAllRoutes();
 
   TripPattern getPatternForTrip(Trip trip);