Refactor RoutingAccessEgress to have a list of last states instead of singular last state

Author: optionsome

application/src/ext/java/org/opentripplanner/ext/ridehailing/RideHailingAccessAdapter.java

@@ -14,7 +14,7 @@ public final class RideHailingAccessAdapter extends DefaultAccessEgress {
   private final Duration arrival;
 
   public RideHailingAccessAdapter(RoutingAccessEgress access, Duration arrival) {
-    super(access.stop(), access.getLastState());
+    super(access.stop(), access.getLastStates());
     this.arrival = arrival;
   }
 

application/src/ext/java/org/opentripplanner/ext/ridehailing/RideHailingAccessShifter.java

@@ -12,6 +12,7 @@
 import org.opentripplanner.routing.algorithm.raptoradapter.transit.RoutingAccessEgress;
 import org.opentripplanner.routing.api.request.RouteRequest;
 import org.opentripplanner.routing.api.request.StreetMode;
+import org.opentripplanner.street.search.state.State;
 import org.opentripplanner.transit.model.framework.Result;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -45,7 +46,7 @@ public static List<RoutingAccessEgress> shiftAccesses(
       .map(ae -> {
         // only time-shift access legs on a car
         // (there could be walk-only accesses if you're close to the stop)
-        if (isAccess && ae.getLastState().containsModeCar()) {
+        if (isAccess && ae.getLastStates().stream().allMatch(State::containsModeCar)) {
           var duration = fetchArrivalDelay(services, request, now);
           if (duration.isSuccess()) {
             return new RideHailingAccessAdapter(ae, duration.successValue());

application/src/main/java/org/opentripplanner/routing/algorithm/mapping/RaptorPathToItineraryMapper.java

@@ -489,12 +489,9 @@ private boolean includeTransferInItinerary(Leg transitLegBeforeTransfer) {
   }
 
   private Itinerary mapAccessEgressPathLeg(RaptorAccessEgress accessEgress) {
-    return accessEgress
-      .findOriginal(RoutingAccessEgress.class)
-      .map(RoutingAccessEgress::getLastState)
-      .map(GraphPath::new)
-      .map(path -> graphPathToItineraryMapper.generateItinerary(path, request))
-      .orElseThrow();
+    var routingAccessEgress = accessEgress.findOriginal(RoutingAccessEgress.class).orElseThrow();
+    var paths = routingAccessEgress.getLastStates().stream().map(GraphPath::new).toList();
+    return graphPathToItineraryMapper.generateItinerary(paths, request);
   }
 
   private TimeAndCost mapAccessEgressPenalty(RaptorAccessEgress accessEgress) {

application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/DefaultAccessEgress.java

@@ -1,10 +1,12 @@
 package org.opentripplanner.routing.algorithm.raptoradapter.transit;
 
+import java.util.List;
 import java.util.Objects;
 import org.opentripplanner.framework.model.TimeAndCost;
 import org.opentripplanner.raptor.api.model.RaptorConstants;
 import org.opentripplanner.raptor.api.model.RaptorCostConverter;
 import org.opentripplanner.street.search.state.State;
+import org.opentripplanner.utils.collection.ListUtils;
 
 /**
  * Default implementation of the RaptorAccessEgress interface.
@@ -20,9 +22,11 @@ public class DefaultAccessEgress implements RoutingAccessEgress {
   private final TimeAndCost penalty;
 
   /**
-   * This should be the last state both in the case of access and egress.
+   * For access, this is a list of states starting from origin to the access stop split at via
+   * locations visited inside the access. For egress, this is a list starting at the egress stop
+   * ending at the destination split at the via locations visited inside the egress.
    */
-  private final State lastState;
+  private final List<State> lastStates;
 
   /**
    * This is public to allow unit-tests full control over the field values.
@@ -32,26 +36,32 @@ public DefaultAccessEgress(
     int durationInSeconds,
     int generalizedCost,
     TimeAndCost penalty,
-    State lastState
+    List<State> lastState
   ) {
     this.stop = stop;
     this.durationInSeconds = durationInSeconds;
     this.generalizedCost = generalizedCost;
     this.timePenalty = penalty.isZero() ? RaptorConstants.TIME_NOT_SET : penalty.timeInSeconds();
     this.penalty = penalty;
-    this.lastState = Objects.requireNonNull(lastState);
+    this.lastStates = ListUtils.requireAtLeastNElements(lastState, 1);
   }
 
-  public DefaultAccessEgress(int stop, State lastState) {
+  public DefaultAccessEgress(int stop, List<State> lastStates) {
     this(
       stop,
-      (int) lastState.getElapsedTimeSeconds(),
-      RaptorCostConverter.toRaptorCost(lastState.getWeight()),
+      (int) lastStates.stream().mapToLong(State::getElapsedTimeSeconds).reduce(0, Long::sum),
+      RaptorCostConverter.toRaptorCost(
+        lastStates.stream().mapToDouble(State::getWeight).reduce(0, Double::sum)
+      ),
       TimeAndCost.ZERO,
-      lastState
+      lastStates
     );
   }
 
+  public DefaultAccessEgress(int stop, State lastState) {
+    this(stop, List.of(Objects.requireNonNull(lastState)));
+  }
+
   protected DefaultAccessEgress(RoutingAccessEgress other, TimeAndCost penalty) {
     // In the API we have a cost associated with the time-penalty. In Raptor, there is no
     // association between the time-penalty and the cost. So, we add the time-penalty cost to
@@ -61,7 +71,7 @@ protected DefaultAccessEgress(RoutingAccessEgress other, TimeAndCost penalty) {
       other.durationInSeconds(),
       other.c1() + penalty.cost().toCentiSeconds(),
       penalty,
-      other.getLastState()
+      other.getLastStates()
     );
     if (other.penalty() != TimeAndCost.ZERO) {
       throw new IllegalStateException("Can not add penalty twice...");
@@ -94,13 +104,13 @@ public boolean hasOpeningHours() {
   }
 
   @Override
-  public State getLastState() {
-    return lastState;
+  public List<State> getLastStates() {
+    return lastStates;
   }
 
   @Override
   public boolean isWalkOnly() {
-    return lastState.containsOnlyWalkMode();
+    return lastStates.stream().allMatch(State::containsOnlyWalkMode);
   }
 
   @Override

application/src/main/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/RoutingAccessEgress.java

@@ -1,5 +1,6 @@
 package org.opentripplanner.routing.algorithm.raptoradapter.transit;
 
+import java.util.List;
 import org.opentripplanner.framework.model.TimeAndCost;
 import org.opentripplanner.raptor.api.model.RaptorAccessEgress;
 import org.opentripplanner.street.search.state.State;
@@ -18,9 +19,11 @@ public interface RoutingAccessEgress extends RaptorAccessEgress {
   RoutingAccessEgress withPenalty(TimeAndCost penalty);
 
   /**
-   * Return the last state both in the case of access and egress.
+   * For access, this is a list of states starting from origin to the access stop split at via
+   * locations visited inside the access. For egress, this is a list starting at the egress stop
+   * ending at the destination split at the via locations visited inside the egress.
    */
-  State getLastState();
+  List<State> getLastStates();
 
   /**
    * Return true if all edges are traversed on foot.

application/src/test/java/org/opentripplanner/raptorlegacy/_data/transit/TestAccessEgress.java

@@ -2,6 +2,7 @@
 
 import static org.opentripplanner.raptor.api.model.RaptorCostConverter.toRaptorCost;
 
+import java.util.List;
 import org.opentripplanner._support.geometry.Coordinates;
 import org.opentripplanner.core.model.i18n.I18NString;
 import org.opentripplanner.framework.model.TimeAndCost;
@@ -109,16 +110,18 @@ Builder stopReachedOnBoard() {
 
     RoutingAccessEgress build() {
       var stopId = "Stop:" + stop;
-      var lastState = new State(
-        new StreetLocation(stopId, Coordinates.BOSTON, I18NString.of(stopId)),
-        StreetSearchRequest.of().build()
+      var lastStates = List.of(
+        new State(
+          new StreetLocation(stopId, Coordinates.BOSTON, I18NString.of(stopId)),
+          StreetSearchRequest.of().build()
+        )
       );
       return new DefaultAccessEgress(
         stop,
         durationInSeconds,
         generalizedCost,
         TimeAndCost.ZERO,
-        lastState
+        lastStates
       ) {
         // TODO - Use the domain type FlexAccessEgressAdapter here instead [if numberOfRides > 0]
         @Override

application/src/test/java/org/opentripplanner/routing/algorithm/raptoradapter/transit/DefaultAccessEgressTest.java

@@ -1,11 +1,13 @@
 package org.opentripplanner.routing.algorithm.raptoradapter.transit;
 
+import static com.google.common.truth.Truth.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.time.Duration;
+import java.util.List;
 import org.junit.jupiter.api.Test;
 import org.opentripplanner.framework.model.Cost;
 import org.opentripplanner.framework.model.TimeAndCost;
@@ -62,8 +64,8 @@ void hasOpeningHours() {
   }
 
   @Test
-  void getLastState() {
-    assertEquals(LAST_STATE, subject.getLastState());
+  void getLastStates() {
+    assertEquals(List.of(LAST_STATE), subject.getLastStates());
   }
 
   /**
@@ -75,7 +77,9 @@ void getLastState() {
   void containsDriving() {
     var state = TestStateBuilder.ofDriving().streetEdge().streetEdge().streetEdge().build();
     var access = new DefaultAccessEgress(0, state);
-    assertTrue(access.getLastState().containsModeCar());
+    var lastStates = access.getLastStates();
+    assertThat(lastStates).hasSize(1);
+    assertTrue(lastStates.getFirst().containsModeCar());
   }
 
   /**
@@ -87,7 +91,9 @@ void containsDriving() {
   void walking() {
     var state = TestStateBuilder.ofWalking().streetEdge().streetEdge().streetEdge().build();
     var access = new DefaultAccessEgress(0, state);
-    assertFalse(access.getLastState().containsModeCar());
+    var lastStates = access.getLastStates();
+    assertThat(lastStates).hasSize(1);
+    assertFalse(lastStates.getFirst().containsModeCar());
   }
 
   @Test