Skip to content

Remove walk leg in a stay seated transfer - #5135

Merged
optionsome merged 4 commits into
opentripplanner:dev-2.xfrom
HSLdevcom:remove-interline-walk
Jun 14, 2023
Merged

Remove walk leg in a stay seated transfer#5135
optionsome merged 4 commits into
opentripplanner:dev-2.xfrom
HSLdevcom:remove-interline-walk

Conversation

@optionsome

Copy link
Copy Markdown
Member

Summary

Removes walk between two trips that have a stay seated transfer. OTP1 did not have a walk leg in an interline transfer.

Issue

closes #5086

Unit tests

TODO

Documentation

Not needed

Changelog

From title

@optionsome optionsome added the !Bug Apply to issues describing a bug and PRs witch fixes it. label May 23, 2023
@optionsome optionsome added this to the 2.4 (next release) milestone May 23, 2023
@optionsome

Copy link
Copy Markdown
Member Author

There is an issue that the walk leg has a cost that affects the total cost of the itinerary but if we remove the walk leg, the cost is no longer attached to any leg in the end results and the cost of the walk leg might affect results. Also, I'm not sure if a transfer is blocked because the user wouldn't be able to walk in time between two stops (even though that is not really needed).

@codecov

codecov Bot commented May 23, 2023

Copy link
Copy Markdown

Codecov Report

Patch coverage: 86.76% and project coverage change: +0.55 🎉

Comparison is base (b157ce2) 64.78% compared to head (6d1a12d) 65.34%.

Additional details and impacted files
@@              Coverage Diff              @@
##             dev-2.x    #5135      +/-   ##
=============================================
+ Coverage      64.78%   65.34%   +0.55%     
- Complexity     14164    14421     +257     
=============================================
  Files           1733     1751      +18     
  Lines          67502    67862     +360     
  Branches        7223     7221       -2     
=============================================
+ Hits           43730    44343     +613     
+ Misses         21344    21057     -287     
- Partials        2428     2462      +34     
Impacted Files Coverage Δ
...algorithm/mapping/RaptorPathToItineraryMapper.java 72.34% <50.00%> (-1.39%) ⬇️
...graphqlapi/datafetchers/LegacyGraphQLStopImpl.java 17.07% <66.66%> (+4.04%) ⬆️
.../org/opentripplanner/ext/geocoder/LuceneIndex.java 68.57% <87.50%> (+1.14%) ⬆️
.../org/opentripplanner/ext/geocoder/StopCluster.java 100.00% <100.00%> (ø)
...pentripplanner/ext/geocoder/StopClusterMapper.java 96.77% <100.00%> (ø)
...planner/transit/service/DefaultTransitService.java 47.61% <100.00%> (+5.08%) ⬆️

... and 168 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@t2gran
t2gran self-requested a review May 30, 2023 08:31
@optionsome optionsome added the Digitransit Test Feature is under testing in Digitransit environment(s) label Jun 2, 2023
@optionsome
optionsome marked this pull request as ready for review June 8, 2023 13:36
@optionsome
optionsome requested a review from a team as a code owner June 8, 2023 13:36
@optionsome

Copy link
Copy Markdown
Member Author

We discussed this pr today in the dev meeting and whether tests should be written for it in the scope of this pr. @t2gran thought it would make sense to do some refactoring so we can write better tests outside of this pr.

@leonardehrenfried
leonardehrenfried self-requested a review June 8, 2023 14:06
return transitSearchTimeZero.plusSeconds(timeInSeconds);
}

private boolean staySeatedInTransferFrom(Leg transitLeg) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please document why this is necessary and perhaps link to the relevant tickets.

@leonardehrenfried leonardehrenfried left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please document.

@t2gran t2gran left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, but @leonardehrenfried comment triggered my review. This is a bit detailed - maybe too much, but to be clean I would do it like the suggested code.

If you use // to document a business feature, it is probably better to extract a method with a name witch hints to what you try to achieve, and write JavaDoc for details. This does not interrupt the reader of the main code, and let hen to go and read the detail if hen want.

Comment on lines +108 to +111
// Map transfer leg but not when there is a stay seated transfer as the transfer leg would be
// a walk/bicycle leg between two stops (more details in
// https://github.com/opentripplanner/OpenTripPlanner/issues/5086).
else if (pathLeg.isTransferLeg() && !staySeatedInTransferFrom(transitLeg)) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put the doc on the method as JavaDoc and name the method according to its intention. Also, I would code the if like this keeping the same abstraction level in each outer block:

if (pathLeg.isTransitLeg()) {
  ...
}
else if (pathLeg.isTransferLeg() {
  if(includeTransferInItinerary(transitLeg)) {
    ...
  }
}

The following else is implicit, but not included, because it is considered noice and unlikely to happen, if
we expected more leg types to be added later it would make sense to add it.

else {
  throw IllegalStateException("Unexpected leg type: " + pathLeg);
}

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good points, I have updated the code.

optionsome and others added 2 commits June 13, 2023 21:07
…ptorPathToItineraryMapper.java

Co-authored-by: Thomas Gran <t2gran@gmail.com>
@optionsome
optionsome merged commit d614d8d into opentripplanner:dev-2.x Jun 14, 2023
@optionsome
optionsome deleted the remove-interline-walk branch June 14, 2023 08:35
t2gran pushed a commit that referenced this pull request Jun 14, 2023
EmmaSimon added a commit to mbta/OpenTripPlanner that referenced this pull request Jun 22, 2023
* Add changelog entry for opentripplanner#5100 [ci skip]

* refactor: Add proper progress tracking for GraphQL timeouts.

* refactor: Fix spelling 'guarantied' -> 'guaranteed'

* review: Fix documentation

* feature: Trace HTTP request headers

* Add changelog entry for opentripplanner#5081 [ci skip]

* Add changelog entry for opentripplanner#5091 [ci skip]

* Add changelog entry for opentripplanner#5133 [ci skip]

* Remove unused code

* Generate full POM for shaded jar [ci skip]

* Add elevation data to Transmodel API

* Finetune elevation format

* Update documentation

* Add changelog entry for opentripplanner#5142 [ci skip]

* fix: Make sure the log key is removed from the Grizzly thread log context

* Apply suggestions from code review

Co-authored-by: Thomas Gran <t2gran@gmail.com>

* Remove San Francisco fare calculator

* Remove TimeBasedVehicleRentalFareService

* Add documentation about deleted calculators

* Remove empty lines

* Refactor null check on from and to vertices

* review: Apply review feedback

* Apply suggestions from code review

Co-authored-by: Leonard Ehrenfried <mail@leonard.io>

* feature: Add sanity check for HTTP header value

The value must match `[^\p{Cntrl}\v]{1,512}`

* test: Add test regular expression for HTTP header value

* Apply suggestions from code review

Co-authored-by: Leonard Ehrenfried <mail@leonard.io>

* feature: Remove batch query from Transmodel API

* refactor: re-generate doc

* fix(deps): update dependency com.google.guava:guava to v32

* fix(deps): update dependency com.graphql-java:graphql-java to v20.3

* Add changelog entry for opentripplanner#5130 [ci skip]

* fix(deps): update dependency com.google.guava:guava to v32

* Use git to figure out last-modified date

* Debug last modified check

* Increase fetch depth

* Make update frequency a Duration

* fix(deps): update dependency com.fasterxml.jackson.core:jackson-annotations to v2.15.2

* Update log messages

* Update docs

* Remove link to 1.x-dev docs

* refactor: Avoid creating builders unnecessary.

* test: Add test for bug in TripRequestMapperTest

* Add changelog entry for opentripplanner#5131 [ci skip]

* Bump serialization version id for opentripplanner#5131

* Add changelog entry for opentripplanner#5141 [ci skip]

* Bump serialization version id for opentripplanner#5141

* Improve money documentation

* Implement stop sequence in GraphQL

* Add stop sequence and test

* Fix docs, formatting and tests

* Add test for walk step mapping

* fix: Fix bug in maxDirectDurationForMode and refactor

 - The code is not DRY, so I refactored it - this also fixes the bug

* refactor: Extract mappers out off PreferencesMapper

* fix(deps): update dependency com.google.cloud:libraries-bom to v26.15.0

* fix(deps): update dependency org.onebusaway:onebusaway-gtfs to v1.4.3

* Make absolute direction optional

* Add test for GraphQL API

* Add changelog entry for opentripplanner#5140 [ci skip]

* Update documentation

* Add changelog entry for opentripplanner#5145 [ci skip]

* Consider level and layer tags when linking public transit stop area nodes

E.g. transit entrances above ground should not get directly linked to subway platforms

* Add test for ensuring that entrances do not link to platforms across different layers/levels

* Update documentation and mapping

* test: Add regression test.

* fix: Fix validation of flex area, assert isComplete and isConsistent, before isStopTimesIncreasing

* refactor: Cleanup AbstractStopTimeAdaptor

* Improve documentation

* Handle stop areas with many platforms properly

Entrances and other unconnected nodes included in stop area relation were
linked only with the first platform area. Now they are matched with all platforms.
Walkable area builder won't create connections if node is outside a platform.

* Update documenation

* Create interline transfers for trips that share the same service date and block

* Connect area boundary to entrance points inside it to prevent pruning

* Add better test data for testing area processing of stop_area relations

* Validate to/from in routing request

* Add changelog entry for opentripplanner#5152 [ci skip]

* Bump serialization version id for opentripplanner#5152

* Stop area linking tests

* Changing default value for earlyStartSec

* Add some documetation about stop area relations

* Fix formatting

* Add support for mapping NeTEx operating day in operating period

* Add error mapping in REST API

* Update documentation

* Add new doc page to mkdocs.yml

* Move getLevel to OSMWithTags andd simplify it

* Test also layer tag relevance in stop area processing

* Fix misleading data report issue content from stop area processing

* Use multimap for storing stop area link nodes

* Remove obsolete issue

Stop area which does not have entrances or other link points is really not any kind of error

* Add changelog entry for opentripplanner#5147 [ci skip]

* Improve updater log messages

* refactor: Apply code review

 - Change `earlyStartSec:int` to `earlyStart:Duration`
 - Add more doc on parameter

* Relax validity check for flex trip with null duration

* Make FlexPath fields final

* refactor: Make `SiriSXUpdaterParameters#timeout` a Duration

* Apply suggestions from code review

* refactor: Make Siri Updaters use Duration, not int, for reminding parameters

 - This also remove a bit of unnecessary mapping code.

* Update src/main/java/org/opentripplanner/standalone/config/routerconfig/updaters/SiriSXUpdaterConfig.java

Co-authored-by: Leonard Ehrenfried <mail@leonard.io>

* chore(deps): update dependency org.apache.maven.plugins:maven-surefire-plugin to v3.1.2

* Refactor shutdown hook

* Add changelog entry for opentripplanner#5159 [ci skip]

* Update pull_request_template.md [ci skip]

* fix(deps): update dependency com.graphql-java:graphql-java to v20.4

* Use hashmultimap in  src/main/java/org/opentripplanner/graph_builder/module/osm/OsmDatabase.java>

Co-authored-by: Leonard Ehrenfried <mail@leonard.io>

* Add HashMultimap import

* Refactor first/last date getters

* Split method in two

* Update src/main/java/org/opentripplanner/graph_builder/module/interlining/InterlineProcessor.java

Co-authored-by: Thomas Gran <t2gran@gmail.com>

* More accurate tagging instructions, one example relation linked

* Log warning if GBFS status reports unexpected vehicle type

* Code cleanup

* refactor: Cleanup TransitRouter and AccessEgressMapper

* refactor: Sort values in DurationForEnum.toString to make it deterministic

* refactor: Add State.containsModeWalkOnly() and DefaultAccessEgress.isWalkOnly()

These methods will make it simpler to filter access/egress later

* refactor: Add Duration#requireNonNegative(Duration) : Duration to DurationUtils

* refactor: Implement openingHoursToString() for AccessEgress for testing

Having to brows through many classes and hairy logic is time-consuming when
debugging FLEX access/egress, this simplifies the process.

* refactor: Move RaptorConstants into raptor.api.model package

* feature: Search before the earliest-departure-time in Raptor with searchWindowAccessSlack.

* refactor: Move AccessEgresses to street package

* refactor: Cleanup DoubleUtils

* refactor: Add requireXyz to IntUtils

* refactor: Add Cost value-object

* refactor: Improve int and double utilities

* refactor: Small cleanups

* Apply suggestions from code review

Co-authored-by: Thomas Gran <t2gran@gmail.com>

* Formatting

* Add changelog entry for opentripplanner#5161 [ci skip]

* Add changelog entry for opentripplanner#5162 [ci skip]

* Add changelog entry for opentripplanner#5168 [ci skip]

* Apply review suggestions

* Apply review suggestions

* Fix bicyle optimise type in TransmodelApi

* Add test for optimize type in GraphQL API

* fix(deps): update dependency com.google.guava:guava to v32.0.1-jre

* Add changelog entry for opentripplanner#5167 [ci skip]

* Add reusable method

* Add union type for stop position

* Simplify type resolving

* Use interface type in data fetcher

* Applied review suggestion

* Add documentation

* Add documentation

* Apply review feedback

Co-authored-by: Joel Lappalainen <lappalj8@gmail.com>

* Generate new SiriUpdater doc

* Add changelog entry for opentripplanner#5169 [ci skip]

* Add changelog entry for opentripplanner#5175 [ci skip]

* Add changelog entry for opentripplanner#5164 [ci skip]

* Add changelog entry for opentripplanner#5165 [ci skip]

* review: Remove serialVersionUID

* Validate that from and to temporary vertices are distinct

* review: Extract TestVehicleRentalStationBuilder

* Reduce log severity for non-optimized transfers

* Return an int as the stopPosition for StopTimes

* doc: Move JavaDoc to accessors, fix typo.

* fix: Improve error handling and prevent OTP from going down when connecting to external http services.

The VehicleRentalServiceDirectoryFetcher went down with a IllegalSateException when the
http endpoint failed. Instead of returning null in some error-cases and throwing IOExceptions
in others the HttpUtils is changed to throw an IOException in all cases. This make it more
robust, and the checked exception forces the client to handle it.

* Use Finland OSM mapping as basis for constant speed mapper

* Add support for taxi mode

* Rename ConstansSpeedMapper to describe the new super class

* Add changelog entry for opentripplanner#5153 [ci skip]

* Update micrometer.version to v1.11.1

* Update src/main/java/org/opentripplanner/routing/algorithm/mapping/RaptorPathToItineraryMapper.java

Co-authored-by: Thomas Gran <t2gran@gmail.com>

* Apply review feedback

* Update dependency ch.qos.logback:logback-classic to v1.4.8

* Add changelog entry for opentripplanner#5135 [ci skip]

* Separate words with underscore in osm tag mapper enum value

* Update docs

* Bump serialization version id for opentripplanner#5176

* Make stop area linking more precise and capable to handle elevators

* Add changelog entry for opentripplanner#5181 [ci skip]

* Use EnumSet instead of Stream

* Add changelog entry for opentripplanner#5183 [ci skip]

* Add changelog entry for opentripplanner#5179 [ci skip]

* Fix formatting in RouterConfig.md

* improve: add language argument to Quay and StopPlace types

deprecate lang arguments

* fix: the overloaded getLocale method does not use the language argument

* improve: extract shared code into helper method in transmodel GqlUtil

* add test for GqlUtil.getLocale

* Fix default value for bicycle safety report

* Update dependency org.apache.maven.plugins:maven-shade-plugin to v3.5.0

* Update dependency net.logstash.logback:logstash-logback-encoder to v7.4

* Update dependency org.mockito:mockito-core to v5.4.0

* Add more tests for stop area linking
- Test that elevators get linked
- Test that stop positions will not get linked

* Fix typo

* Update src/main/java/org/opentripplanner/openstreetmap/model/OSMWithTags.java

Co-authored-by: Leonard Ehrenfried <mail@leonard.io>

* Return set

* Update src/main/java/org/opentripplanner/openstreetmap/model/OSMWithTags.java

Co-authored-by: Joel Lappalainen <lappalj8@gmail.com>

* Update src/main/java/org/opentripplanner/openstreetmap/model/OSMWithTags.java

Co-authored-by: Joel Lappalainen <lappalj8@gmail.com>

* Add changelog entry for opentripplanner#5166 [ci skip]

---------

Co-authored-by: Leonard Ehrenfried <mail@leonard.io>
Co-authored-by: OTP Changelog Bot <changelog-bot@opentripplanner.org>
Co-authored-by: Thomas Gran <t2gran@gmail.com>
Co-authored-by: vpaturet <46598384+vpaturet@users.noreply.github.com>
Co-authored-by: Vincent Paturet <vincent.paturet@entur.org>
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: OTP Serialization Version Bot <serialization-version-bot@opentripplanner.org>
Co-authored-by: Vesa Meskanen <vesa.meskanen@cgi.com>
Co-authored-by: Joel Lappalainen <lappalj8@gmail.com>
Co-authored-by: Lasse Tyrihjell <lassetyr@gmail.com>
Co-authored-by: Vesa Meskanen <vesa@realsoft.com>
Co-authored-by: Tom Erik Støwer <testower@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

!Bug Apply to issues describing a bug and PRs witch fixes it. Digitransit Test Feature is under testing in Digitransit environment(s)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Walk leg between interlining trips

3 participants