ISO-8601 date time for GTFS API itinerary responses

docs/apis/GraphQL-Tutorial.md

@@ -88,25 +88,33 @@ Most people want to get routing results out of OTP, so lets see the query for th
             },
         ]) {
         itineraries {
-            startTime
-            endTime
+            start
+            end
             legs {
                 mode
-                startTime
-                endTime
+                start {
+                    scheduled
+                    actual
+                    delay
+                }
+                end {
+                    scheduled
+                    actual
+                    delay
+                }
                 from {
                     name
                     lat
                     lon
-                    departureTime
-                    arrivalTime
+                    departure
+                    arrival
                 }
                 to {
                     name
                     lat
                     lon
-                    departureTime
-                    arrivalTime
+                    departure
+                    arrival
                 }
                 route {
                     gtfsId

magidoc.mjs

@@ -35,7 +35,8 @@ To learn how to deactivate it, read the
       appTitle: 'OTP GTFS GraphQL API',
       queryGenerationFactories: {
         'Polyline': '<>',
-        'GeoJson': '<>'
+        'GeoJson': '<>',
+        'OffsetDateTime': '2024-02-05T18:04:23+0100'
       },
     }
   },

src/ext/java/org/opentripplanner/ext/fares/impl/CombinedInterlinedTransitLeg.java

@@ -10,6 +10,7 @@
 import org.opentripplanner.framework.collection.ListUtils;
 import org.opentripplanner.model.fare.FareProductUse;
 import org.opentripplanner.model.plan.Leg;
+import org.opentripplanner.model.plan.LegTimes;
 import org.opentripplanner.model.plan.Place;
 import org.opentripplanner.model.plan.StopArrival;
 import org.opentripplanner.model.plan.TransitLeg;
@@ -56,6 +57,16 @@ public Trip getTrip() {
     return first.getTrip();
   }
 
+  @Override
+  public LegTimes start() {
+    return LegTimes.of(getEndTime(), getDepartureDelay());
+  }
+
+  @Override
+  public LegTimes end() {
+    return LegTimes.of(getStartTime(), getArrivalDelay());
+  }
+
   @Override
   public ZonedDateTime getStartTime() {
     return first.getStartTime();

src/ext/java/org/opentripplanner/ext/flex/FlexibleTransitLeg.java

@@ -16,6 +16,7 @@
 import org.opentripplanner.model.PickDrop;
 import org.opentripplanner.model.fare.FareProductUse;
 import org.opentripplanner.model.plan.Leg;
+import org.opentripplanner.model.plan.LegTimes;
 import org.opentripplanner.model.plan.Place;
 import org.opentripplanner.model.plan.StopArrival;
 import org.opentripplanner.model.plan.TransitLeg;
@@ -84,6 +85,16 @@ public Accessibility getTripWheelchairAccessibility() {
     return edge.getFlexTrip().getTrip().getWheelchairBoarding();
   }
 
+  @Override
+  public LegTimes start() {
+    return LegTimes.of(startTime, getArrivalDelay());
+  }
+
+  @Override
+  public LegTimes end() {
+    return LegTimes.of(endTime, getDepartureDelay());
+  }
+
   @Override
   @Nonnull
   public TransitMode getMode() {

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

@@ -10,6 +10,10 @@
 import graphql.schema.CoercingParseValueException;
 import graphql.schema.CoercingSerializeException;
 import graphql.schema.GraphQLScalarType;
+import java.time.OffsetDateTime;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
+import javax.annotation.Nonnull;
 import org.locationtech.jts.geom.Geometry;
 import org.opentripplanner.framework.geometry.GeometryUtils;
 import org.opentripplanner.framework.graphql.scalar.DurationScalarFactory;
@@ -50,6 +54,34 @@ public String parseLiteral(Object input) {
     )
     .build();
 
+  public static GraphQLScalarType offsetDateTimeScalar = GraphQLScalarType
+    .newScalar()
+    .name("OffsetDateTime")
+    .coercing(
+      new Coercing<OffsetDateTime, String>() {
+        @Override
+        public String serialize(@Nonnull Object dataFetcherResult)
+          throws CoercingSerializeException {
+          if (dataFetcherResult instanceof ZonedDateTime zdt) {
+            return zdt.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME);
+          } else if (dataFetcherResult instanceof OffsetDateTime odt) {
+            return odt.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME);
+          } else return null;
+        }
+
+        @Override
+        public OffsetDateTime parseValue(Object input) throws CoercingParseValueException {
+          return null;
+        }
+
+        @Override
+        public OffsetDateTime parseLiteral(Object input) throws CoercingParseLiteralException {
+          return null;
+        }
+      }
+    )
+    .build();
+
   public static GraphQLScalarType geoJsonScalar = GraphQLScalarType
     .newScalar()
     .name("GeoJson")

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

@@ -111,6 +111,7 @@ protected static GraphQLSchema buildSchema() {
         .scalar(GraphQLScalars.geoJsonScalar)
         .scalar(GraphQLScalars.graphQLIDScalar)
         .scalar(GraphQLScalars.gramsScalar)
+        .scalar(GraphQLScalars.offsetDateTimeScalar)
         .scalar(ExtendedScalars.GraphQLLong)
         .type("Node", type -> type.typeResolver(new NodeTypeResolver()))
         .type("PlaceInterface", type -> type.typeResolver(new PlaceInterfaceTypeResolver()))

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

@@ -2,6 +2,7 @@
 
 import graphql.schema.DataFetcher;
 import graphql.schema.DataFetchingEnvironment;
+import java.time.OffsetDateTime;
 import java.util.List;
 import org.opentripplanner.apis.gtfs.generated.GraphQLDataFetchers;
 import org.opentripplanner.apis.gtfs.mapping.NumberMapper;
@@ -32,6 +33,12 @@ public DataFetcher<Double> elevationLost() {
     return environment -> getSource(environment).getElevationLost();
   }
 
+  @Override
+  public DataFetcher<OffsetDateTime> end() {
+    return environment -> getSource(environment).endTime().toOffsetDateTime();
+  }
+
+  @Deprecated
   @Override
   public DataFetcher<Long> endTime() {
     return environment -> getSource(environment).endTime().toInstant().toEpochMilli();
@@ -57,6 +64,12 @@ public DataFetcher<Integer> numberOfTransfers() {
     return environment -> getSource(environment).getNumberOfTransfers();
   }
 
+  @Override
+  public DataFetcher<OffsetDateTime> start() {
+    return environment -> getSource(environment).startTime().toOffsetDateTime();
+  }
+
+  @Deprecated
   @Override
   public DataFetcher<Long> startTime() {
     return environment -> getSource(environment).startTime().toInstant().toEpochMilli();

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

@@ -18,6 +18,7 @@
 import org.opentripplanner.model.PickDrop;
 import org.opentripplanner.model.fare.FareProductUse;
 import org.opentripplanner.model.plan.Leg;
+import org.opentripplanner.model.plan.LegTimes;
 import org.opentripplanner.model.plan.ScheduledTransitLeg;
 import org.opentripplanner.model.plan.StopArrival;
 import org.opentripplanner.model.plan.StreetLeg;
@@ -78,6 +79,12 @@ public DataFetcher<Double> duration() {
   }
 
   @Override
+  public DataFetcher<LegTimes> end() {
+    return environment -> getSource(environment).end();
+  }
+
+  @Override
+  @Deprecated
   public DataFetcher<Long> endTime() {
     return environment -> getSource(environment).getEndTime().toInstant().toEpochMilli();
   }
@@ -216,6 +223,12 @@ public DataFetcher<String> serviceDate() {
   }
 
   @Override
+  public DataFetcher<LegTimes> start() {
+    return environment -> getSource(environment).start();
+  }
+
+  @Override
+  @Deprecated
   public DataFetcher<Long> startTime() {
     return environment -> getSource(environment).getStartTime().toInstant().toEpochMilli();
   }

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

@@ -2,6 +2,7 @@
 
 import graphql.schema.DataFetcher;
 import graphql.schema.DataFetchingEnvironment;
+import java.time.OffsetDateTime;
 import org.opentripplanner.apis.gtfs.generated.GraphQLDataFetchers;
 import org.opentripplanner.apis.gtfs.generated.GraphQLTypes.GraphQLVertexType;
 import org.opentripplanner.apis.gtfs.model.StopPosition;
@@ -17,6 +18,12 @@
 
 public class PlaceImpl implements GraphQLDataFetchers.GraphQLPlace {
 
+  @Override
+  public DataFetcher<OffsetDateTime> arrival() {
+    return environment -> getSource(environment).arrival.toOffsetDateTime();
+  }
+
+  @Deprecated
   @Override
   public DataFetcher<Long> arrivalTime() {
     return environment -> getSource(environment).arrival.toInstant().toEpochMilli();
@@ -45,6 +52,12 @@ public DataFetcher<VehicleParking> carPark() {
     return this::getCarPark;
   }
 
+  @Deprecated
+  @Override
+  public DataFetcher<OffsetDateTime> departure() {
+    return environment -> getSource(environment).departure.toOffsetDateTime();
+  }
+
   @Override
   public DataFetcher<Long> departureTime() {
     return environment -> getSource(environment).departure.toInstant().toEpochMilli();

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

@@ -36,6 +36,7 @@
 import org.opentripplanner.model.plan.Emissions;
 import org.opentripplanner.model.plan.Itinerary;
 import org.opentripplanner.model.plan.Leg;
+import org.opentripplanner.model.plan.LegTimes;
 import org.opentripplanner.model.plan.StopArrival;
 import org.opentripplanner.model.plan.WalkStep;
 import org.opentripplanner.routing.alertpatch.TransitAlert;
@@ -400,6 +401,8 @@ public interface GraphQLItinerary {
 
     public DataFetcher<Emissions> emissionsPerPerson();
 
+    public DataFetcher<java.time.OffsetDateTime> end();
+
     public DataFetcher<Long> endTime();
 
     public DataFetcher<Iterable<Object>> fares();
@@ -410,6 +413,8 @@ public interface GraphQLItinerary {
 
     public DataFetcher<Integer> numberOfTransfers();
 
+    public DataFetcher<java.time.OffsetDateTime> start();
+
     public DataFetcher<Long> startTime();
 
     public DataFetcher<Iterable<SystemNotice>> systemNotices();
@@ -440,6 +445,8 @@ public interface GraphQLLeg {
 
     public DataFetcher<Double> duration();
 
+    public DataFetcher<LegTimes> end();
+
     public DataFetcher<Long> endTime();
 
     public DataFetcher<Iterable<FareProductUse>> fareProducts();
@@ -480,6 +487,8 @@ public interface GraphQLLeg {
 
     public DataFetcher<String> serviceDate();
 
+    public DataFetcher<LegTimes> start();
+
     public DataFetcher<Long> startTime();
 
     public DataFetcher<Iterable<WalkStep>> steps();
@@ -493,6 +502,14 @@ public interface GraphQLLeg {
     public DataFetcher<Boolean> walkingBike();
   }
 
+  public interface GraphQLLegTimes {
+    public DataFetcher<java.time.OffsetDateTime> actual();
+
+    public DataFetcher<java.time.Duration> delay();
+
+    public DataFetcher<java.time.OffsetDateTime> scheduled();
+  }
+
   /** A span of time. */
   public interface GraphQLLocalTimeSpan {
     public DataFetcher<Integer> from();
@@ -576,6 +593,8 @@ public interface GraphQLPattern {
   }
 
   public interface GraphQLPlace {
+    public DataFetcher<java.time.OffsetDateTime> arrival();
+
     public DataFetcher<Long> arrivalTime();
 
     public DataFetcher<VehicleParking> bikePark();
@@ -584,6 +603,8 @@ public interface GraphQLPlace {
 
     public DataFetcher<VehicleParking> carPark();
 
+    public DataFetcher<java.time.OffsetDateTime> departure();
+
     public DataFetcher<Long> departureTime();
 
     public DataFetcher<Double> lat();

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

@@ -26,6 +26,7 @@ config:
     Polyline: String
     GeoJson: org.locationtech.jts.geom.Geometry
     Grams: org.opentripplanner.framework.model.Grams
+    OffsetDateTime: java.time.OffsetDateTime
     Duration: java.time.Duration
   mappers:
     AbsoluteDirection: org.opentripplanner.apis.gtfs.generated.GraphQLTypes.GraphQLAbsoluteDirection#GraphQLAbsoluteDirection
@@ -59,6 +60,7 @@ config:
     InputField: org.opentripplanner.apis.gtfs.generated.GraphQLTypes.GraphQLInputField#GraphQLInputField
     Itinerary: org.opentripplanner.model.plan.Itinerary#Itinerary
     Leg: org.opentripplanner.model.plan.Leg#Leg
+    LegTimes: org.opentripplanner.model.plan.LegTimes#LegTimes
     Mode: String
     OccupancyStatus: org.opentripplanner.apis.gtfs.generated.GraphQLTypes.GraphQLOccupancyStatus#GraphQLOccupancyStatus
     TransitMode: org.opentripplanner.apis.gtfs.generated.GraphQLTypes.GraphQLTransitMode#GraphQLTransitMode

src/main/java/org/opentripplanner/model/plan/Leg.java

@@ -200,6 +200,9 @@ default Accessibility getTripWheelchairAccessibility() {
     return null;
   }
 
+  LegTimes start();
+  LegTimes end();
+
   /**
    * The date and time this leg begins.
    */

src/main/java/org/opentripplanner/model/plan/LegTimes.java

@@ -0,0 +1,26 @@
+package org.opentripplanner.model.plan;
+
+import java.time.Duration;
+import java.time.ZonedDateTime;
+import java.util.Objects;
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+public record LegTimes(
+  @Nonnull ZonedDateTime scheduled,
+  @Nullable ZonedDateTime actual,
+  @Nullable Duration delay
+) {
+  public LegTimes {
+    Objects.requireNonNull(scheduled);
+  }
+  @Nonnull
+  public static LegTimes of(ZonedDateTime realtime, int delaySecs) {
+    var delay = Duration.ofSeconds(delaySecs);
+    return new LegTimes(realtime.minus(delay), realtime, delay);
+  }
+  @Nonnull
+  public static LegTimes ofStatic(ZonedDateTime staticTime) {
+    return new LegTimes(staticTime, staticTime, Duration.ZERO);
+  }
+}