Add 'transfers' build config field #6215

VillePihlava · 2024-11-01T11:15:40Z

Summary

This PR adds the transfers build config field for configuring transfers. These parameters can be configured for all transfer modes:

disableDefaultTransfers: allows disabling default transfer calculations
maxTransferDuration: allows configuring a mode-specific maxTransferDuration
carsAllowedStopMaxTransferDuration: allows changing max transfer durations between stops that allow cars

This is a follow-up PR related to #5966. Example configuration:

  "transfers": {
    "CAR": {
      "disableDefaultTransfers": true,
      "carsAllowedStopMaxTransferDuration": "3h"
    },
    "BIKE": {
      "maxTransferDuration": "30m",
      "carsAllowedStopMaxTransferDuration": "3h"
    }
  },

Issue

This is a follow-up PR related to issue #5875.

Unit tests

I created new unit tests for testing the changes to the DirectTransferGenerator

Documentation

Changes to BuildConfiguration.md

Bumping the serialization version id

This change affects how transfers are calculated and adds a new field to the build-config.json file.

…th the 'carsAllowedStopMaxTransferDurationsForMode' build config parameter.

…ig parameter.

codecov · 2024-11-01T11:21:38Z

Codecov Report

Attention: Patch coverage is 78.22581% with 27 lines in your changes missing coverage. Please review.

Project coverage is 69.86%. Comparing base (3a37262) to head (2e57c2f).
Report is 4 commits behind head on dev-2.x.

Files with missing lines	Patch %	Lines
...e/config/buildconfig/TransferParametersMapper.java	0.00%	20 Missing ⚠️
.../graph_builder/module/DirectTransferGenerator.java	91.78%	2 Missing and 4 partials ⚠️
.../standalone/config/buildconfig/TransferConfig.java	85.71%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #6215      +/-   ##
=============================================
+ Coverage      69.85%   69.86%   +0.01%     
- Complexity     17917    17939      +22     
=============================================
  Files           2035     2038       +3     
  Lines          76497    76609     +112     
  Branches        7822     7834      +12     
=============================================
+ Hits           53436    53524      +88     
- Misses         20325    20347      +22     
- Partials        2736     2738       +2

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

habrahamsson-skanetrafiken · 2024-11-05T10:47:23Z

There are some conflicts

…into car-transferrequest-filtering

optionsome

I've had too many reviews today already so I didn't go properly through this. However, inspired by some concerns from @t2gran, I think to avoid issues we should do a couple of things:

Introduce carsAllowedStopMaxAccessEgressDurationsForMode. This is to prevent weird back-and-forth transfers to avoid access and egress duration limitations.
Prevent these transfers from being used by other street modes. I don't know if this is already done or not but I think at least previously all the transfers were in the same collection. This could again lead to weird back and forth travel by walking for example to escape some other restrictions.

optionsome · 2024-11-08T12:52:25Z

application/src/main/java/org/opentripplanner/api/parameter/QualifiedModeSet.java

-            mBuilder.withEgressMode(StreetMode.WALK);
-            mBuilder.withDirectMode(StreetMode.CAR);
+            // This is used in transfer cache request calculations.
+            mBuilder.withAllStreetModes(StreetMode.CAR);


I know this builder method wasn't introduced in this pr but this name is really confusing. Idk what we call Access+Transfer+Egress+Direct. It's difficult to come up with a name that doesn't confuse you into thinking that all modes are enabled. Just making this singular would maybe make it less confusing.

I changed it to set each mode separately for more clarity

optionsome · 2024-11-08T13:09:21Z

application/src/main/java/org/opentripplanner/graph_builder/module/DirectTransferGenerator.java

@@ -60,6 +68,23 @@ public DirectTransferGenerator(
    this.issueStore = issueStore;
    this.radiusByDuration = radiusByDuration;
    this.transferRequests = transferRequests;
+    this.carsAllowedStopMaxTransferDurationsForMode = DurationForEnum.of(StreetMode.class).build();


Maybe we should always include this with some default value that is the same as the normal transfer duration limit.

This has changed quite a lot, but you can look at how I handle an empty parameter

optionsome · 2024-11-08T13:09:56Z

application/src/main/java/org/opentripplanner/graph_builder/module/DirectTransferGenerator.java

+      .stream()
+      .map(StopLocation::getId)
+      .map(graph::getStopVertexForStopId)
+      .filter(TransitStopVertex.class::isInstance) // filter out null values if no TransitStopVertex is found for ID


Inline comments are not allowed.

VillePihlava · 2024-11-12T11:14:30Z

I'm changing this to a draft for now. I'll return to this once the work on the separate transfer request collections for modes has been completed.

… tests.

…nsferrequest-filtering

…into car-transferrequest-filtering

VillePihlava added 3 commits November 1, 2024 11:58

Add ability to create special transfer requests for cars and bikes wi…

36336bf

…th the 'carsAllowedStopMaxTransferDurationsForMode' build config parameter.

Add tests for 'carsAllowedStopMaxTransferDurationsForMode' build conf…

f1380e3

…ig parameter.

Move if statement outside of for loop.

2175e64

VillePihlava requested a review from a team as a code owner November 1, 2024 11:15

habrahamsson-skanetrafiken requested review from optionsome and leonardehrenfried November 5, 2024 10:47

Merge branch 'dev-2.x' of github.com:opentripplanner/OpenTripPlanner …

6418e26

…into car-transferrequest-filtering

optionsome reviewed Nov 8, 2024

View reviewed changes

VillePihlava marked this pull request as draft November 12, 2024 11:14

VillePihlava added 3 commits December 3, 2024 08:43

Fixes based on review comments.

e1e9bbb

Add TransferParameters to build config.

89e617f

Remove mentions of carsAllowedStopMaxTransferDurationsForMode and fix…

a1e0807

… tests.

VillePihlava changed the title ~~Add carsAllowedStopMaxTransferDurationsForMode build config parameter~~ Add 'transfers build config field Dec 3, 2024

VillePihlava changed the title ~~Add 'transfers build config field~~ Add 'transfers' build config field Dec 3, 2024

VillePihlava added 6 commits December 5, 2024 10:00

Rename variables and small improvements.

21bb307

Change test.

573078a

Add documentation for build config fields.

3fd5bf5

Add logging for transfers.

35c98bc

Merge branch 'split-transfers-by-mode-pathtransfer-mode' into car-tra…

3a34aa4

…nsferrequest-filtering

Fix merge issues.

97238a3

VillePihlava mentioned this pull request Dec 9, 2024

Enable mode-specific transfers by storing mode information in transfers #6293

Merged

VillePihlava added 6 commits December 10, 2024 12:02

Add tests and small improvements.

41a0674

Merge branch 'dev-2.x' of github.com:opentripplanner/OpenTripPlanner …

1a3f846

…into car-transferrequest-filtering

Refactor transfer parameter parsing.

2e048f9

Remove duplicate test.

c90c3ec

Simplify implementation by removing changes to StreetNearbyStopFinder.

30cc925

Remove unnecessary parameter from function call.

2e57c2f

VillePihlava marked this pull request as ready for review December 17, 2024 08:10

VillePihlava requested a review from optionsome December 17, 2024 08:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add 'transfers' build config field #6215

Add 'transfers' build config field #6215

VillePihlava commented Nov 1, 2024 •

edited

Loading

codecov bot commented Nov 1, 2024 •

edited

Loading

habrahamsson-skanetrafiken commented Nov 5, 2024

optionsome left a comment

optionsome Nov 8, 2024

VillePihlava Dec 17, 2024

optionsome Nov 8, 2024

VillePihlava Dec 17, 2024

optionsome Nov 8, 2024

VillePihlava Dec 17, 2024

VillePihlava commented Nov 12, 2024

Add 'transfers' build config field #6215

Are you sure you want to change the base?

Add 'transfers' build config field #6215

Conversation

VillePihlava commented Nov 1, 2024 • edited Loading

Summary

Issue

Unit tests

Documentation

Bumping the serialization version id

codecov bot commented Nov 1, 2024 • edited Loading

Codecov Report

habrahamsson-skanetrafiken commented Nov 5, 2024

optionsome left a comment

Choose a reason for hiding this comment

optionsome Nov 8, 2024

Choose a reason for hiding this comment

VillePihlava Dec 17, 2024

Choose a reason for hiding this comment

optionsome Nov 8, 2024

Choose a reason for hiding this comment

VillePihlava Dec 17, 2024

Choose a reason for hiding this comment

optionsome Nov 8, 2024

Choose a reason for hiding this comment

VillePihlava Dec 17, 2024

Choose a reason for hiding this comment

VillePihlava commented Nov 12, 2024

VillePihlava commented Nov 1, 2024 •

edited

Loading

codecov bot commented Nov 1, 2024 •

edited

Loading