Add `generalizedCostMaxLimit` field to the `PageCursor` to enable using `RemoveTransitIfStreetOnlyIsBetter` filter with paging #6474

VillePihlava · 2025-02-20T12:44:50Z

Summary

This PR adds the generalizedCostMaxLimit field to the PageCursor. This enables using the RemoveTransitIfStreetOnlyIsBetter filter with paging. Before this PR, this was not possible because paging only used the walk mode to create a direct itinerary which made the filter work incorrectly.

Issue

N/A

Unit tests

Changed existing unit tests for compatibility and created new ones. Also performed manual testing.

Documentation

Code comments, no other documentation

codecov · 2025-02-20T12:50:50Z

Codecov Report

Attention: Patch coverage is 93.41317% with 11 lines in your changes missing coverage. Please review.

Project coverage is 70.13%. Comparing base (62b4982) to head (833acec).
Report is 282 commits behind head on dev-2.x.

Files with missing lines	Patch %	Lines
...del/plan/paging/cursor/DefaultPageCursorInput.java	79.31%	6 Missing ⚠️
...model/plan/paging/cursor/PageCursorSerializer.java	95.83%	1 Missing and 1 partial ⚠️
...rithm/mapping/RouteRequestToFilterChainMapper.java	50.00%	1 Missing and 1 partial ⚠️
...m/filterchain/ItineraryListFilterChainBuilder.java	83.33%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #6474      +/-   ##
=============================================
- Coverage      70.31%   70.13%   -0.19%     
- Complexity     18158    18282     +124     
=============================================
  Files           2058     2078      +20     
  Lines          76939    77742     +803     
  Branches        7771     7835      +64     
=============================================
+ Hits           54097    54521     +424     
- Misses         20088    20443     +355     
- Partials        2754     2778      +24

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

VillePihlava · 2025-02-21T08:40:06Z

I removed the direct mode search with paging and refactored bestStreetOnlyCost to streetOnlyCost. This should now be ready-for-review.

optionsome · 2025-02-25T13:36:49Z

...ation/src/main/java/org/opentripplanner/model/plan/paging/cursor/DefaultPageCursorInput.java

+public class DefaultPageCursorInput implements PageCursorInput {
+
+  private final NumItinerariesFilterResults numItinerariesFilterResults;
+  private final OptionalInt streetOnlyCost;


We don't use optionals for fields, we can although expose it as one through a getter.

Consider using another custom Results type here, like NumItinerariesFilterResults, for readability. That would preserve the general idea that the pageCursor depends on results from some filters.

I created a RemoveTransitIfStreetOnlyIsBetterResults record and removed optionals from fields.

optionsome · 2025-02-25T13:39:02Z

...ation/src/main/java/org/opentripplanner/model/plan/paging/cursor/DefaultPageCursorInput.java

+  public DefaultPageCursorInput() {
+    this.numItinerariesFilterResults = null;
+    this.streetOnlyCost = OptionalInt.empty();
+  }
+
+  public DefaultPageCursorInput(Builder builder) {
+    this.numItinerariesFilterResults = builder.numItinerariesFilterResults();
+    this.streetOnlyCost = builder.streetOnlyCost();
+  }


Do these constructors need to be public if we use a builder for constructing this? Is the first constructor necessary?

I made these constructors private. The first constructor is used with the of() method

optionsome · 2025-02-25T13:40:36Z

...ation/src/main/java/org/opentripplanner/model/plan/paging/cursor/DefaultPageCursorInput.java

+  public static class Builder {
+
+    private NumItinerariesFilterResults numItinerariesFilterResults;
+    private OptionalInt streetOnlyCost;


Same as above.

I created a RemoveTransitIfStreetOnlyIsBetterResults record and removed optionals from fields.

optionsome · 2025-02-25T13:43:42Z

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

@@ -24,11 +25,17 @@ public record PageCursor(
  Instant earliestDepartureTime,
  Instant latestArrivalTime,
  Duration searchWindow,
-  @Nullable ItinerarySortKey itineraryPageCut
+  @Nullable ItinerarySortKey itineraryPageCut,
+  OptionalInt streetOnlyCost


Same as above.

I created a RemoveTransitIfStreetOnlyIsBetterResults record and removed optionals from fields. Here I use the field generalizedCostMaxLimit that can be null

optionsome · 2025-02-25T13:45:52Z

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

@@ -50,18 +51,23 @@ public PageCursorFactory withOriginalSearch(
  }

  /**
+   * This adds the page cursor input to the factory. The cursor input can contain information about filtering results
+   * or the best street only cost.


Suggested change

* or the best street only cost.

* or the street only cost.

I changed the comment and removed the mention of the street only cost

optionsome · 2025-02-25T14:13:31Z

...planner/routing/algorithm/filterchain/filters/transit/RemoveTransitIfStreetOnlyIsBetter.java

+  public RemoveTransitIfStreetOnlyIsBetter(
+    CostLinearFunction costLimitFunction,
+    OptionalInt streetOnlyCost,
+    Consumer<OptionalInt> streetOnlyCostSubscriber
+  ) {


Document when the streetOnlyCost is present and when the subscriber is present.

I created documentation for this method

optionsome · 2025-02-25T14:15:18Z

...planner/routing/algorithm/filterchain/filters/transit/RemoveTransitIfStreetOnlyIsBetter.java

      return List.of();
+    } else if (minStreetCost.isPresent() && streetOnlyCost.isPresent()) {
+      // If both the minStreetCost and streetOnlyCost are present, take the minimum value.


Is this possible a case?

This should not be a possible case since the walk direct search is removed with paging. I changed this to throw an error if this case happens

optionsome · 2025-02-25T14:17:30Z

...main/java/org/opentripplanner/routing/algorithm/mapping/RouteRequestToFilterChainMapper.java

@@ -46,6 +48,11 @@ public static ItineraryListFilterChain createFilterChain(
      builder = builder.withPagingDeduplicationFilter(request.pageCursor().itineraryPageCut());
    }

+    // The page cursor has best street only cost information only in certain cases.


You could document what those certain cases are.

I documented this

optionsome · 2025-02-25T14:21:20Z

application/src/main/java/org/opentripplanner/routing/algorithm/RoutingWorker.java

-    // If no direct mode is set, then we set one.
-    // See {@link FilterTransitWhenDirectModeIsEmpty}
-    var emptyDirectModeHandler = new FilterTransitWhenDirectModeIsEmpty(
-      request.journey().direct().mode()
-    );
-
-    request.journey().direct().setMode(emptyDirectModeHandler.resolveDirectMode());


Was this only used when paging or also when user decided to search with transitOnly: true? I don't know if we should change that behaviour.

with transitOnly: true the mode gets unset here

OpenTripPlanner/application/src/main/java/org/opentripplanner/apis/gtfs/mapping/routerequest/ModePreferencesMapper.java

Line 29 in 7d90276

journey.direct().setMode(StreetMode.NOT_SET);

so to me it seems that this is not related to transitOnly

optionsome · 2025-02-25T14:23:30Z

...ner/routing/algorithm/filterchain/filters/transit/RemoveTransitIfStreetOnlyIsBetterTest.java

@@ -17,6 +18,8 @@

 public class RemoveTransitIfStreetOnlyIsBetterTest implements PlanTestConstants {

+  OptionalInt subscribeResult = OptionalInt.empty();


Optional as a field here.

I created a RemoveTransitIfStreetOnlyIsBetterResults record and removed optionals from fields

eibakke · 2025-02-25T15:03:41Z

application/src/main/java/org/opentripplanner/routing/algorithm/RoutingWorker.java

+        it -> pageCursorInputBuilder = pageCursorInputBuilder.withNumItinerariesFilterResults(it),
+        it -> pageCursorInputBuilder = pageCursorInputBuilder.withStreetOnlyCost(it)


It's a bit strange to pass the builder functions directly into the filter builder. Consider making filter results vars for each of the two filters here, and then passing the filter results into the pageCursorInputBuilder later.

I created separate variables for the subscriber results. I build the DefaultPageCursorInput later in the createPagingService method

…ror with case that should not happen.

VillePihlava added 6 commits February 14, 2025 15:32

Initial version.

316db17

Fix null checks.

4391ac3

Fix tests.

cd6a152

Fix tests and implementation.

2324f68

Fix implementation.

5b1e251

Add tests.

77c3cfc

VillePihlava requested a review from a team as a code owner February 20, 2025 12:44

VillePihlava added 2 commits February 21, 2025 10:12

Remove direct mode search with paging.

9af6665

Refactor bestStreetOnlyCost to streetOnlyCost, related to PageCursor.

7c84581

VillePihlava changed the title ~~Add bestStreetOnlyCost field to the PageCursor to enable using RemoveTransitIfStreetOnlyIsBetter filter with paging~~ Add streetOnlyCost field to the PageCursor to enable using RemoveTransitIfStreetOnlyIsBetter filter with paging Feb 21, 2025

optionsome requested review from eibakke and optionsome February 24, 2025 16:27

optionsome requested changes Feb 25, 2025

View reviewed changes

eibakke reviewed Feb 25, 2025

View reviewed changes

VillePihlava added 8 commits February 27, 2025 15:21

Add RemoveTransitIfStreetOnlyIsBetterResults and refactoring.

ba3a817

Make DefaultPageCursorInput constructors private.

97a4749

Change comment.

e59b70a

Change comments.

45a7c43

Refactor how the DefaultPageCursorInput is built in RoutingWorker.

7cabb40

Add toString method to NumItinerariesFilterResults.

b66e83f

Refactor and document RemoveTransitIfStreetOnlyIsBetter, and throw er…

e7b641f

…ror with case that should not happen.

Add documentation.

833acec

VillePihlava changed the title ~~Add streetOnlyCost field to the PageCursor to enable using RemoveTransitIfStreetOnlyIsBetter filter with paging~~ Add generalizedCostMaxLimit field to the PageCursor to enable using RemoveTransitIfStreetOnlyIsBetter filter with paging Mar 6, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `generalizedCostMaxLimit` field to the `PageCursor` to enable using `RemoveTransitIfStreetOnlyIsBetter` filter with paging #6474

Add `generalizedCostMaxLimit` field to the `PageCursor` to enable using `RemoveTransitIfStreetOnlyIsBetter` filter with paging #6474

VillePihlava commented Feb 20, 2025 •

edited

Loading

codecov bot commented Feb 20, 2025 •

edited

Loading

VillePihlava commented Feb 21, 2025

optionsome Feb 25, 2025

eibakke Feb 25, 2025

VillePihlava Feb 27, 2025

optionsome Feb 25, 2025

VillePihlava Feb 27, 2025

optionsome Feb 25, 2025

VillePihlava Feb 27, 2025

optionsome Feb 25, 2025

VillePihlava Feb 27, 2025

optionsome Feb 25, 2025

VillePihlava Feb 27, 2025

optionsome Feb 25, 2025

VillePihlava Feb 27, 2025

optionsome Feb 25, 2025

VillePihlava Feb 27, 2025

optionsome Feb 25, 2025

VillePihlava Feb 27, 2025

optionsome Feb 25, 2025

VillePihlava Feb 27, 2025

optionsome Feb 25, 2025

VillePihlava Feb 27, 2025

eibakke Feb 25, 2025

VillePihlava Feb 27, 2025

		@@ -17,6 +18,8 @@

		public class RemoveTransitIfStreetOnlyIsBetterTest implements PlanTestConstants {

		OptionalInt subscribeResult = OptionalInt.empty();

		it -> pageCursorInputBuilder = pageCursorInputBuilder.withNumItinerariesFilterResults(it),
		it -> pageCursorInputBuilder = pageCursorInputBuilder.withStreetOnlyCost(it)

Add generalizedCostMaxLimit field to the PageCursor to enable using RemoveTransitIfStreetOnlyIsBetter filter with paging #6474

Are you sure you want to change the base?

Add generalizedCostMaxLimit field to the PageCursor to enable using RemoveTransitIfStreetOnlyIsBetter filter with paging #6474

Conversation

VillePihlava commented Feb 20, 2025 • edited Loading

Summary

Issue

Unit tests

Documentation

codecov bot commented Feb 20, 2025 • edited Loading

Codecov Report

VillePihlava commented Feb 21, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `generalizedCostMaxLimit` field to the `PageCursor` to enable using `RemoveTransitIfStreetOnlyIsBetter` filter with paging #6474

Add `generalizedCostMaxLimit` field to the `PageCursor` to enable using `RemoveTransitIfStreetOnlyIsBetter` filter with paging #6474

VillePihlava commented Feb 20, 2025 •

edited

Loading

codecov bot commented Feb 20, 2025 •

edited

Loading