Move firstSearchLatestItineraryDeparture logic into PageCursorFactory.

Author: VillePihlava

application/src/main/java/org/opentripplanner/model/plan/paging/cursor/PageCursorFactory.java

@@ -5,7 +5,9 @@
 
 import java.time.Duration;
 import java.time.Instant;
+import java.util.List;
 import javax.annotation.Nullable;
+import org.opentripplanner.model.plan.Itinerary;
 import org.opentripplanner.model.plan.ItinerarySortKey;
 import org.opentripplanner.model.plan.SortOrder;
 import org.opentripplanner.utils.tostring.ToStringBuilder;
@@ -50,7 +52,8 @@ public PageCursorFactory withOriginalSearch(
     @Nullable PageType pageType,
     Instant edt,
     Instant lat,
-    Duration searchWindow
+    Duration searchWindow,
+    List<Itinerary> itineraries
   ) {
     this.currentPageType = pageType == null
       ? resolvePageTypeForTheFirstSearch(sortOrder)
@@ -59,6 +62,11 @@ public PageCursorFactory withOriginalSearch(
     this.currentEdt = edt;
     this.currentLat = lat;
     this.currentSearchWindow = searchWindow;
+    this.firstSearchLatestItineraryDeparture = resolveFirstSearchLatestItineraryDeparture(
+      pageType,
+      itineraries,
+      edt
+    );
     return this;
   }
 
@@ -125,10 +133,29 @@ public String toString() {
    * ascending, and to PREVIOUS if descending. We do this because the logic for the first search is
    * equivalent when creating new cursors.
    */
-  public static PageType resolvePageTypeForTheFirstSearch(SortOrder sortOrder) {
+  private static PageType resolvePageTypeForTheFirstSearch(SortOrder sortOrder) {
     return sortOrder.isSortedByAscendingArrivalTime() ? NEXT_PAGE : PREVIOUS_PAGE;
   }
 
+  /**
+   * If the first search is an arrive by search, store the latest itinerary's start time
+   * to allow setting cursor information correctly for the page cursor of the next page.
+   */
+  private Instant resolveFirstSearchLatestItineraryDeparture(
+    @Nullable PageType pageType,
+    List<Itinerary> itineraries,
+    Instant edt
+  ) {
+    if (pageType == null && resolvePageTypeForTheFirstSearch(sortOrder) == PREVIOUS_PAGE) {
+      if (itineraries.size() > 0) {
+        return itineraries.get(0).startTimeAsInstant();
+      } else {
+        return edt;
+      }
+    }
+    return null;
+  }
+
   /** Create page cursor pair (next and previous) */
   private void createPageCursors() {
     if (currentEdt == null || nextCursor != null || prevCursor != null) {

application/src/main/java/org/opentripplanner/service/paging/PagingService.java

@@ -1,7 +1,5 @@
 package org.opentripplanner.service.paging;
 
-import static org.opentripplanner.model.plan.paging.cursor.PageType.PREVIOUS_PAGE;
-
 import java.time.Duration;
 import java.time.Instant;
 import java.util.List;
@@ -183,36 +181,16 @@ private PageCursorFactory mapIntoPageCursorFactory(@Nullable PageType currentPag
       currentPageType,
       earliestDepartureTime,
       latestArrivalTime,
-      searchWindowUsed
+      searchWindowUsed,
+      itineraries
     );
 
-    handleFirstSearch(currentPageType, factory);
-
     if (pageCursorInput != null) {
       factory = factory.withRemovedItineraries(pageCursorInput);
     }
     return factory;
   }
 
-  /**
-   * If the first search is an arrive by search, add the latest itinerary's start time
-   * to allow setting cursor information correctly for the page cursor of the next page.
-   */
-  private void handleFirstSearch(@Nullable PageType currentPageType, PageCursorFactory factory) {
-    if (
-      currentPageType == null &&
-      PageCursorFactory.resolvePageTypeForTheFirstSearch(itinerariesSortOrder) == PREVIOUS_PAGE
-    ) {
-      if (itineraries.size() > 0) {
-        factory = factory.withFirstSearchLatestItineraryDeparture(
-          itineraries.get(0).startTimeAsInstant()
-        );
-      } else {
-        factory = factory.withFirstSearchLatestItineraryDeparture(earliestDepartureTime);
-      }
-    }
-  }
-
   private void assertRequestPrerequisites() {
     if (noSuccessfulTransitSearchPerformed()) {
       throw new IllegalStateException("SearchWindow not set");

application/src/test/java/org/opentripplanner/model/plan/paging/cursor/PageCursorFactoryTest.java

@@ -9,6 +9,7 @@
 
 import java.time.Duration;
 import java.time.Instant;
+import java.util.List;
 import org.junit.jupiter.api.Test;
 import org.opentripplanner.model.plan.Itinerary;
 import org.opentripplanner.model.plan.ItinerarySortKey;
@@ -26,6 +27,7 @@ class PageCursorFactoryTest implements PlanTestConstants {
   private static final Instant T10_30 = time("10:30");
   private static final Instant T11_01 = time("11:01");
   private static final Instant T12_00 = time("12:00");
+  private static final Instant T12_01 = time("12:01");
   private static final Instant T12_10 = time("12:10");
   private static final Instant T12_30 = time("12:30");
   private static final Instant T13_00 = time("13:00");
@@ -37,7 +39,8 @@ public void sortArrivalAscending() {
       null,
       T12_00,
       null,
-      D1H
+      D1H,
+      List.of()
     );
 
     var nextPage = factory.nextPageCursor();
@@ -50,7 +53,7 @@ public void sortArrivalAscending() {
   @Test
   public void sortArrivalAscendingCropSearchWindow() {
     var factory = new PageCursorFactory(STREET_AND_ARRIVAL_TIME, D90M)
-      .withOriginalSearch(NEXT_PAGE, T12_00, null, D1H)
+      .withOriginalSearch(NEXT_PAGE, T12_00, null, D1H, List.of())
       .withRemovedItineraries(
         new TestPageCursorInput(
           newItinerary(A).bus(55, timeAsSeconds(T12_00), timeAsSeconds(T12_10), B).build(),
@@ -71,7 +74,8 @@ public void sortArrivalAscendingPreviousPage() {
       PREVIOUS_PAGE,
       T12_00,
       null,
-      D1H
+      D1H,
+      List.of()
     );
 
     var nextPage = factory.nextPageCursor();
@@ -84,7 +88,7 @@ public void sortArrivalAscendingPreviousPage() {
   @Test
   public void sortArrivalAscendingCropSearchWindowPreviousPage() {
     var factory = new PageCursorFactory(STREET_AND_ARRIVAL_TIME, D90M)
-      .withOriginalSearch(PREVIOUS_PAGE, T12_00, null, D1H)
+      .withOriginalSearch(PREVIOUS_PAGE, T12_00, null, D1H, List.of())
       .withRemovedItineraries(
         new TestPageCursorInput(
           newItinerary(A).bus(55, timeAsSeconds(T12_00), timeAsSeconds(T12_10), B).build(),
@@ -105,11 +109,12 @@ public void sortDepartureDescending() {
       null,
       T12_00,
       T13_30,
-      D1H
+      D1H,
+      List.of()
     );
 
     var nextPage = factory.nextPageCursor();
-    assertPageCursor(nextPage, T13_00, null, D90M, NEXT_PAGE, false);
+    assertPageCursor(nextPage, T12_01, null, D90M, NEXT_PAGE, false);
 
     var prevPage = factory.previousPageCursor();
     assertPageCursor(prevPage, T10_30, T13_30, D90M, PREVIOUS_PAGE, false);
@@ -118,7 +123,7 @@ public void sortDepartureDescending() {
   @Test
   public void sortDepartureDescendingCropSearchWindow() {
     var factory = new PageCursorFactory(STREET_AND_DEPARTURE_TIME, D90M)
-      .withOriginalSearch(PREVIOUS_PAGE, T12_00, T13_30, D1H)
+      .withOriginalSearch(PREVIOUS_PAGE, T12_00, T13_30, D1H, List.of())
       .withRemovedItineraries(
         new TestPageCursorInput(
           newItinerary(A).bus(55, timeAsSeconds(T12_00), timeAsSeconds(T12_30), B).build(),
@@ -139,7 +144,8 @@ public void sortDepartureDescendingNextPage() {
       NEXT_PAGE,
       T12_00,
       T13_30,
-      D1H
+      D1H,
+      List.of()
     );
 
     var nextPage = factory.nextPageCursor();
@@ -152,7 +158,7 @@ public void sortDepartureDescendingNextPage() {
   @Test
   public void sortDepartureDescendingCropSearchWindowNextPage() {
     var factory = new PageCursorFactory(STREET_AND_DEPARTURE_TIME, D90M)
-      .withOriginalSearch(NEXT_PAGE, T12_00, T13_30, D1H)
+      .withOriginalSearch(NEXT_PAGE, T12_00, T13_30, D1H, List.of())
       .withRemovedItineraries(
         new TestPageCursorInput(
           newItinerary(A).bus(55, timeAsSeconds(T12_00), timeAsSeconds(T12_30), B).build(),