Merge branch 'issue-6475-quick-fix' into dev-2.x

Author: optionsome

application/src/main/java/org/opentripplanner/apis/gtfs/datafetchers/StoptimeImpl.java

@@ -85,7 +85,10 @@ public DataFetcher<Integer> stopPositionInPattern() {
 
   @Override
   public DataFetcher<Long> serviceDay() {
-    return environment -> getSource(environment).getServiceDayMidnight();
+    return environment -> {
+      Long midnight = getSource(environment).getServiceDayMidnight();
+      return midnight != TripTimeOnDate.UNDEFINED ? midnight : null;
+    };
   }
 
   @Override

application/src/main/java/org/opentripplanner/apis/gtfs/datafetchers/TripImpl.java

@@ -252,6 +252,12 @@ public DataFetcher<Iterable<TripTimeOnDate>> stoptimes() {
       getTransitService(environment).getScheduledTripTimes(getSource(environment)).orElse(null);
   }
 
+  /**
+   * If stoptimesForDate does not have a parameter, and the trip does not run today, we will
+   * still return a list of TripTimeOnDates, the same list as bare stoptimes() would return.
+   * This is illogical, but existing UIs depend on this longstanding behavior.
+   * @return
+   */
   @Override
   public DataFetcher<Iterable<TripTimeOnDate>> stoptimesForDate() {
     return environment -> {
@@ -260,11 +266,12 @@ public DataFetcher<Iterable<TripTimeOnDate>> stoptimesForDate() {
       var args = new GraphQLTypes.GraphQLTripStoptimesForDateArgs(environment.getArguments());
 
       ZoneId timeZone = transitService.getTimeZone();
-      LocalDate serviceDate = args.getGraphQLServiceDate() != null
-        ? ServiceDateUtils.parseString(args.getGraphQLServiceDate())
-        : LocalDate.now(timeZone);
-
-      return transitService.getTripTimeOnDates(trip, serviceDate).orElse(null);
+      if (args.getGraphQLServiceDate() != null) {
+        LocalDate serviceDate = ServiceDateUtils.parseString(args.getGraphQLServiceDate());
+        return transitService.getTripTimeOnDates(trip, serviceDate).orElse(null);
+      } else {
+        return transitService.getTripTimeOnDates(trip, LocalDate.now(timeZone), true).orElse(null);
+      }
     };
   }
 

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

@@ -121,18 +121,28 @@ public Optional<List<TripTimeOnDate>> getScheduledTripTimes(Trip trip) {
   }
 
   @Override
-  public Optional<List<TripTimeOnDate>> getTripTimeOnDates(Trip trip, LocalDate serviceDate) {
+  public Optional<List<TripTimeOnDate>> getTripTimeOnDates(
+    Trip trip,
+    LocalDate serviceDate,
+    boolean fallbackToPlannedTimetableOnNoServiceDate
+  ) {
     TripPattern pattern = findPattern(trip, serviceDate);
 
     Timetable timetable = findTimetable(pattern, serviceDate);
 
     // This check is made here to avoid changing TripTimeOnDate.fromTripTimes
     TripTimes times = timetable.getTripTimes(trip);
-    if (
-      times == null ||
-      !this.getServiceCodesRunningForDate(serviceDate).contains(times.getServiceCode())
-    ) {
+    if (times == null) {
       return Optional.empty();
+    } else if (!this.getServiceCodesRunningForDate(serviceDate).contains(times.getServiceCode())) {
+      if (fallbackToPlannedTimetableOnNoServiceDate) {
+        // Technically not returning empty here is incorrect, you should use getScheduledTripTimes
+        // above instead if you want this, but it has been the behavior for a very long time, and
+        // at least one longstanding front end will fail without this.
+        return Optional.ofNullable(TripTimeOnDate.fromTripTimes(timetable, trip));
+      } else {
+        return Optional.empty();
+      }
     } else {
       Instant midnight = ServiceDateUtils.asStartOfService(
         serviceDate,
@@ -142,6 +152,11 @@ public Optional<List<TripTimeOnDate>> getTripTimeOnDates(Trip trip, LocalDate se
     }
   }
 
+  @Override
+  public Optional<List<TripTimeOnDate>> getTripTimeOnDates(Trip trip, LocalDate serviceDate) {
+    return getTripTimeOnDates(trip, serviceDate, false);
+  }
+
   @Override
   public Collection<String> listFeedIds() {
     return this.timetableRepository.getFeedIds();

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

@@ -72,6 +72,17 @@ public interface TransitService {
    */
   Optional<List<TripTimeOnDate>> getScheduledTripTimes(Trip trip);
 
+  /**
+   * @return if the trip doesn't run on the specified service date, return scheduled trip times,
+   * unmodified by any realtime data, if fallbackToPlannedTimetableOnNoServiceDate is true, empty
+   * otherwise. Logically this is confusing, but existing API users depend on this.
+   */
+  Optional<List<TripTimeOnDate>> getTripTimeOnDates(
+    Trip trip,
+    LocalDate serviceDate,
+    boolean fallbackToPlannedTimetableOnNoServiceDate
+  );
+
   /**
    * @return empty if the trip doesn't run on the date specified
    */

application/src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

@@ -2495,7 +2495,11 @@ type Trip implements Node {
   "List of times when this trip arrives to or departs from a stop"
   stoptimes: [Stoptime]
   stoptimesForDate(
-    "Date for which stoptimes are returned. Format: YYYYMMDD"
+    """
+    Date for which stoptimes are returned. Format: YYYYMMDD
+    If `serviceDate` is not specified and the trip is not running today, the result is exactly the same
+    as for `stoptimes`, i.e. the scheduled stop times are returned.
+    """
     serviceDate: String
   ): [Stoptime]
   "Coordinates of the route of this trip in Google polyline encoded format"

application/src/test/java/org/opentripplanner/transit/service/DefaultTransitServiceTest.java

@@ -241,6 +241,19 @@ void getRealtimeTripTimes() {
     );
   }
 
+  @Test
+  void getTripTimeOnDateWithNoServiceAndFallbackToPlannedTimetable() {
+    assertEquals(
+      Optional.of(
+        List.of(
+          new TripTimeOnDate(SCHEDULED_TRIP_TIMES, 0, RAIL_PATTERN),
+          new TripTimeOnDate(SCHEDULED_TRIP_TIMES, 1, RAIL_PATTERN)
+        )
+      ),
+      service.getTripTimeOnDates(TRIP, NO_SERVICE_DATE, true)
+    );
+  }
+
   @Test
   void getTripTimesOnNoServiceDay() {
     assertEquals(Optional.empty(), service.getTripTimeOnDates(TRIP, NO_SERVICE_DATE));