Remove banDiscouragedCycling and banDiscouragedWalking #5341

leonardehrenfried · 2023-08-31T15:02:30Z

Summary

This PR removes the configuration options banDiscouragedWalking and banDiscouragedCycling and replaces them with safety factors in the DefaultMapper.

This is more to the spirit of the tag which means that these ways are avoided if possible.

Unit tests

Added.

Documentation

Automatically generated.

codecov · 2023-08-31T15:12:45Z

Codecov Report

Patch coverage: 77.77% and project coverage change: +0.02% 🎉

Comparison is base (ea7b80b) 66.35% compared to head (00ce283) 66.38%.
Report is 16 commits behind head on dev-2.x.

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #5341      +/-   ##
=============================================
+ Coverage      66.35%   66.38%   +0.02%     
- Complexity     15182    15187       +5     
=============================================
  Files           1787     1787              
  Lines          69263    69241      -22     
  Branches        7339     7337       -2     
=============================================
+ Hits           45957    45963       +6     
+ Misses         20825    20796      -29     
- Partials        2481     2482       +1

Files Changed	Coverage Δ
..._builder/module/configure/GraphBuilderModules.java	`0.00% <ø> (ø)`
...ripplanner/graph_builder/module/osm/OsmModule.java	`93.43% <ø> (-0.06%)`	⬇️
...ner/graph_builder/module/osm/OsmModuleBuilder.java	`92.85% <ø> (+10.50%)`	⬆️
...module/osm/parameters/OsmProcessingParameters.java	`100.00% <ø> (ø)`
...opentripplanner/standalone/config/BuildConfig.java	`98.36% <ø> (-0.08%)`	⬇️
...entripplanner/openstreetmap/model/OSMWithTags.java	`89.01% <60.00%> (-0.46%)`	⬇️
...ripplanner/graph_builder/module/osm/OsmFilter.java	`77.31% <100.00%> (+3.06%)`	⬆️
...lanner/openstreetmap/tagmapping/DefaultMapper.java	`100.00% <100.00%> (ø)`

... and 5 files with indirect coverage changes

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

vesameskanen · 2023-09-01T10:55:17Z

src/test/java/org/opentripplanner/openstreetmap/tagmapping/DefaultMapperTest.java

+  void footDiscouraged() {
+    var regular = WayTestData.pedestrianTunnel();
+    var props = wps.getDataForWay(regular);
+    assertEquals(PEDESTRIAN_AND_BICYCLE, props.getPermission());


It is a bit surprising that highway=footway gets BICYCLE permission by default, even when bicycle=no is set. Anyway, that issue is out of the scope of this PR.

Where do you see bicycle=no?

OpenTripPlanner/src/test/java/org/opentripplanner/openstreetmap/wayproperty/specifier/WayTestData.java

Lines 24 to 34 in 3d17964

public static OSMWithTags pedestrianTunnel() {

// https://www.openstreetmap.org/way/127288293

OSMWithTags tunnel = new OSMWithTags();

tunnel.addTag("highway", "footway");

tunnel.addTag("indoor", "yes");

tunnel.addTag("layer", "-1");

tunnel.addTag("lit", "yes");

tunnel.addTag("name", "Lamar Tunnel");

tunnel.addTag("tunnel", "yes");

return tunnel;

}

However, highway=footway should probably not allow bicycles: https://wiki.openstreetmap.org/wiki/Tag:highway=footway?uselang=en

We should indeed change it in a separate PR.

I tested adding bicycle=no myself, just for curiosity :) It did not change anything.

I believe that it's this piece of code taking care of it:

OpenTripPlanner/src/main/java/org/opentripplanner/graph_builder/module/osm/OsmModule.java

Lines 250 to 256 in 73d873b

StreetTraversalPermission permissions = OsmFilter.getPermissionsForWay(

way,

wayData.getPermission(),

params.banDiscouragedWalking(),

params.banDiscouragedBiking(),

issueStore

);

I would be in favour of moving that somehow together with the other code figuring out the permissions.

I started working on that, and also fixing some known errors in traversal permission processing.

optionsome · 2023-09-12T14:33:02Z

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

-  public void addTag(String key, String value) {
-    if (key == null || value == null) return;
+  public OSMWithTags addTag(String key, String value) {
+    if (key == null || value == null) return this;


Can you split the return to its own line or at least wrap it with {}

optionsome · 2023-09-12T14:33:29Z

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

-  public void addTag(String key, String value) {
-    if (key == null || value == null) return;
+  public OSMWithTags addTag(String key, String value) {
+    if (key == null || value == null) return this;

    if (tags == null) tags = new HashMap<>();


optionsome · 2023-09-12T14:38:25Z

src/main/java/org/opentripplanner/openstreetmap/tagmapping/DefaultMapper.java

+    props.setMixinProperties("foot=discouraged", ofWalkSafety(3));
+    props.setMixinProperties("bicycle=discouraged", ofBicycleSafety(3));


I checked that this wasn't handled in the NorwayMapper either and it doesn't rely on the default mapper. I can ask if the norwegians have interest in this too.

Sure, you can ask but I see very, very few instances of this tag in the Nordics: https://taginfo.openstreetmap.org/tags/bicycle=discouraged#map

optionsome

I asked Entur if they needed this change in norway mapper as well but since the tagging is rarely ever used it's not needed.

leonardehrenfried added 3 commits August 31, 2023 16:56

Remove banDiscouraged* functionality

c84240f

Add mixins for foot=discouraged, bicycle=discouraged

caf9795

Update test

b583999

leonardehrenfried added the technical debt label Aug 31, 2023

leonardehrenfried requested a review from a team as a code owner August 31, 2023 15:02

leonardehrenfried added the config change label Aug 31, 2023

vesameskanen previously approved these changes Sep 1, 2023

View reviewed changes

leonardehrenfried requested a review from optionsome September 12, 2023 09:02

leonardehrenfried enabled auto-merge September 12, 2023 09:44

leonardehrenfried added the bump serialization id Add this label if you want the serialization id automatically bumped after merging the PR label Sep 12, 2023

optionsome reviewed Sep 12, 2023

View reviewed changes

Move return statements to their own line

00ce283

leonardehrenfried dismissed vesameskanen’s stale review via 00ce283 September 12, 2023 15:32

leonardehrenfried requested review from vesameskanen and optionsome September 12, 2023 15:36

vesameskanen approved these changes Sep 13, 2023

View reviewed changes

t2gran added this to the 2.5 (next release) milestone Sep 13, 2023

optionsome approved these changes Sep 14, 2023

View reviewed changes

leonardehrenfried merged commit b5cbc95 into opentripplanner:dev-2.x Sep 14, 2023
5 checks passed

t2gran pushed a commit that referenced this pull request Sep 14, 2023

Add changelog entry for #5341 [ci skip]

7e41077

t2gran pushed a commit that referenced this pull request Sep 14, 2023

Bump serialization version id for #5341

72dcf51

leonardehrenfried deleted the ban-discouraged branch September 15, 2023 13:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove banDiscouragedCycling and banDiscouragedWalking #5341

Remove banDiscouragedCycling and banDiscouragedWalking #5341

leonardehrenfried commented Aug 31, 2023

codecov bot commented Aug 31, 2023 •

edited

vesameskanen Sep 1, 2023

leonardehrenfried Sep 1, 2023

vesameskanen Sep 1, 2023

leonardehrenfried Sep 1, 2023

vesameskanen Sep 11, 2023

optionsome Sep 12, 2023

optionsome Sep 12, 2023

optionsome Sep 12, 2023

leonardehrenfried Sep 12, 2023

optionsome left a comment

	public static OSMWithTags pedestrianTunnel() {
	// https://www.openstreetmap.org/way/127288293
	OSMWithTags tunnel = new OSMWithTags();
	tunnel.addTag("highway", "footway");
	tunnel.addTag("indoor", "yes");
	tunnel.addTag("layer", "-1");
	tunnel.addTag("lit", "yes");
	tunnel.addTag("name", "Lamar Tunnel");
	tunnel.addTag("tunnel", "yes");
	return tunnel;
	}

	StreetTraversalPermission permissions = OsmFilter.getPermissionsForWay(
	way,
	wayData.getPermission(),
	params.banDiscouragedWalking(),
	params.banDiscouragedBiking(),
	issueStore
	);

		props.setMixinProperties("foot=discouraged", ofWalkSafety(3));
		props.setMixinProperties("bicycle=discouraged", ofBicycleSafety(3));

Remove banDiscouragedCycling and banDiscouragedWalking #5341

Remove banDiscouragedCycling and banDiscouragedWalking #5341

Conversation

leonardehrenfried commented Aug 31, 2023

Summary

Unit tests

Documentation

codecov bot commented Aug 31, 2023 • edited

Codecov Report

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

optionsome left a comment

Choose a reason for hiding this comment

codecov bot commented Aug 31, 2023 •

edited