Better escalator duration control: specific duration from OSM duration tag, default speed from build-config.json #6268

tkalvas · 2024-11-22T10:13:47Z

Summary

Escalator durations tend too high. This PR makes it possible to use duration=hh:mm:ss tag in OSM data to set the duration accurately. It also makes it possible to set a configuration-wide speed in build-config.json at routingDefaults.escalatorSpeed.

Issue

None.

Unit tests

New case in EscalatorEdgeTest: if a duration is set for the edge, it takes precedence over a calculated duration.

Documentation

doc/user/RouteRequest.md has been autogenerated

Changelog

Definitely will be included in changelog.

Bumping the serialization version id

No

tkalvas · 2024-11-22T10:14:24Z

Will be a draft until I have completed my full-program manual testing.

codecov · 2024-11-22T10:20:33Z

Codecov Report

Attention: Patch coverage is 69.23077% with 24 lines in your changes missing coverage. Please review.

Project coverage is 69.78%. Comparing base (90a6176) to head (c161378).
Report is 156 commits behind head on dev-2.x.

Files with missing lines	Patch %	Lines
...r/graph_builder/module/osm/EscalatorProcessor.java	27.77%	12 Missing and 1 partial ⚠️
...ava/org/opentripplanner/osm/model/OsmWithTags.java	82.14%	1 Missing and 4 partials ⚠️
...nner/inspector/vector/edge/EdgePropertyMapper.java	0.00%	3 Missing ⚠️
...outing/api/request/preference/WalkPreferences.java	84.61%	1 Missing and 1 partial ⚠️
...entripplanner/street/model/edge/EscalatorEdge.java	83.33%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #6268      +/-   ##
=============================================
+ Coverage      69.71%   69.78%   +0.06%     
- Complexity     17697    17786      +89     
=============================================
  Files           2008     2017       +9     
  Lines          75836    76109     +273     
  Branches        7766     7792      +26     
=============================================
+ Hits           52869    53111     +242     
- Misses         20252    20287      +35     
+ Partials        2715     2711       -4

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

application/src/main/java/org/opentripplanner/osm/model/OsmWay.java

…ation in debug client edge popup.

application/src/main/java/org/opentripplanner/graph_builder/module/osm/EscalatorProcessor.java

application/src/main/java/org/opentripplanner/osm/model/OsmWay.java

leonardehrenfried · 2024-11-27T12:22:25Z

...ion/src/main/java/org/opentripplanner/standalone/config/routerequest/RouteRequestConfig.java

@@ -459,6 +460,16 @@ private static void mapStreetPreferences(NodeAdapter c, StreetPreferences.Builde
              .asInt(dftElevator.hopTime())
          );
      })
+      .withEscalator(escalator -> {


If you add an example here: https://github.com/opentripplanner/OpenTripPlanner/blob/198ed907d1c5daf48349c205cdb443f0d0c7dfec/application/src/test/resources/standalone/config/router-config.json it will show up in the documentation.

application/src/main/java/org/opentripplanner/street/model/edge/EscalatorEdge.java

leonardehrenfried

This is a good PR but I've picked up on a few things.

...n/src/main/java/org/opentripplanner/routing/api/request/preference/EscalatorPreferences.java

...ion/src/main/java/org/opentripplanner/standalone/config/routerequest/RouteRequestConfig.java

utils/src/main/java/org/opentripplanner/utils/time/DurationUtils.java

optionsome · 2024-11-27T13:12:47Z

utils/src/main/java/org/opentripplanner/utils/time/DurationUtils.java

+   * @return Duration
+   * @throws DateTimeParseException on bad input
+   */
+  public static Duration parseClockDuration(String duration) {


I wonder if we need this or could we just use Duration.between(LocalTime.MIN, LocalTime.parse(duration))? The parse function probably accepts more formats that what is in theory allowed by OSM tagging.

There are also factories in the data API to create custom parsers - we do not need this.

Joel also wanted to use Duration.between(LocalTime.MIN, LocalTime.parse(duration, DateTimeFormatter.ISO_LOCAL_TIME)), which I guess will probably work ok for durations smaller than 24 hours. But the format specified in https://wiki.openstreetmap.org/wiki/Key:duration does not limit the duration to under 24 hours, which is of course irrelevant for the escalator use case, but if we ever want to recycle the duration tag parsing code for other durations, it might become relevant. Let's go through this in today's meeting.

But now I noticed that my implementation is against the spec anyway. It specifies that the duration is either mm, hh:mm or hh:mm:ss. Not hh, hh:mm or hh:mm:ss as I implemented it.

Anyway, the fact that the supported formats are mm, hh:mm, and hh:mm:ss means that there has to be a place for the switch off the number of colons somewhere, even if the branches use some ready-made parser. I'll bring this up in the meeting as well.

DateTimeFormatterBuilder will not work for this. It has the capability for expressing optional parts, so it could express hh(:mm(:ss)?)? but it cannot express (hh:)?mm(:ss)? where the existence of (:ss) implies the existence of (hh:). Even if it did, it would not be able to handle the cases where hours are greater than 23 or (if there is no hours part at all) minutes are greater than 59, which are both allowed by the spec and exist in OSM data. Durations are not LocalTimes after all, in parsing a LocalTime it makes sense and is correct that hours cannot be more than 23 or minutes more than 59, but in durations if you have capped the largest unit, it is reasonable for the amount of the largest unit to be as large as it needs to be.

I did rewrite the parsing to be quite explicit in what it accepts, so its correctness should be obvious.

…rger than localdate would allow

tkalvas · 2024-11-28T14:20:11Z

While going through the comments, I noticed our ElevatorEdge implementation uses the OSM tag duration as an integer number of seconds, which is just wrong, compared to the duration tag spec. We couldn't even find an elevator tagged like this anywhere.

leonardehrenfried · 2024-11-29T09:18:20Z

application/src/main/java/org/opentripplanner/inspector/vector/edge/EdgePropertyMapper.java

-        case EscalatorEdge e -> List.of(kv("distance", e.getDistanceMeters()));
+        case EscalatorEdge e -> List.of(
+          kv("distance", e.getDistanceMeters()),
+          kv("duration", e.getDuration())


I don't think the underlying library works with Optional or Duration. You will have to convert to a string.

leonardehrenfried · 2024-11-29T09:19:43Z

utils/src/main/java/org/opentripplanner/utils/time/DurationUtils.java

@@ -11,6 +11,7 @@
 import java.util.Optional;
 import java.util.regex.Pattern;
 import java.util.stream.Collectors;
+import org.opentripplanner.utils.lang.StringUtils;


This can go.

tkalvas added 2 commits November 19, 2024 15:47

use duration tag from osm as escalator traversal duration

47300f9

make default escalator speed a configuration parameter

d9ead12

tkalvas requested a review from a team as a code owner November 22, 2024 10:13

tkalvas marked this pull request as draft November 22, 2024 10:14

leonardehrenfried reviewed Nov 25, 2024

View reviewed changes

application/src/main/java/org/opentripplanner/osm/model/OsmWay.java Outdated Show resolved Hide resolved

tkalvas added 4 commits November 25, 2024 10:31

test the added duration tag in OsmWay

8028990

ignore escalator duration tags if the speed are nonsense. include dur…

aa3de3a

…ation in debug client edge popup.

use Optional<Duration> instead of Integer which can be null

4566194

test changes included

3127cf3

tkalvas marked this pull request as ready for review November 25, 2024 12:42

optionsome added bump serialization id Add this label if you want the serialization id automatically bumped after merging the PR Improvement labels Nov 26, 2024

optionsome added this to the 2.7 (next release) milestone Nov 26, 2024

use Optional upwards only

1e5aca1

leonardehrenfried reviewed Nov 27, 2024

View reviewed changes

application/src/main/java/org/opentripplanner/graph_builder/module/osm/EscalatorProcessor.java Show resolved Hide resolved

leonardehrenfried reviewed Nov 27, 2024

View reviewed changes

application/src/main/java/org/opentripplanner/osm/model/OsmWay.java Outdated Show resolved Hide resolved

leonardehrenfried reviewed Nov 27, 2024

View reviewed changes

application/src/main/java/org/opentripplanner/street/model/edge/EscalatorEdge.java Show resolved Hide resolved

leonardehrenfried requested changes Nov 27, 2024

View reviewed changes

optionsome reviewed Nov 27, 2024

View reviewed changes

tkalvas added 2 commits November 28, 2024 15:26

add bad duration tags to issue store, better testing of duration parsing

627b3fd

add tests for the osm duration tag cases where the leading unit is la…

dccc6d3

…rger than localdate would allow

tkalvas added 2 commits November 29, 2024 09:45

explain the duration parser better, more tests

d345a03

prettier reformatting

c161378

leonardehrenfried reviewed Nov 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Better escalator duration control: specific duration from OSM duration tag, default speed from build-config.json #6268

Better escalator duration control: specific duration from OSM duration tag, default speed from build-config.json #6268

tkalvas commented Nov 22, 2024

tkalvas commented Nov 22, 2024

codecov bot commented Nov 22, 2024 •

edited

Loading

leonardehrenfried Nov 27, 2024

leonardehrenfried left a comment

optionsome Nov 27, 2024

t2gran Nov 27, 2024

tkalvas Nov 28, 2024

tkalvas Nov 28, 2024

tkalvas Nov 28, 2024

tkalvas Nov 29, 2024

tkalvas commented Nov 28, 2024

leonardehrenfried Nov 29, 2024

leonardehrenfried Nov 29, 2024

Better escalator duration control: specific duration from OSM duration tag, default speed from build-config.json #6268

Are you sure you want to change the base?

Better escalator duration control: specific duration from OSM duration tag, default speed from build-config.json #6268

Conversation

tkalvas commented Nov 22, 2024

Summary

Issue

Unit tests

Documentation

Changelog

Bumping the serialization version id

tkalvas commented Nov 22, 2024

codecov bot commented Nov 22, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

leonardehrenfried left a 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

tkalvas commented Nov 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 22, 2024 •

edited

Loading