Transit filters for GTFS API's planConnection

[leonardehrenfried]

Summary

This adds the filter API originally developed for the Transmodel API to the GTFS API.

It allows you to included or exclude routes or agencies from the routing result.

For example it allows you to express the following filter criteria:

• give me only results for agency A1
• give me only results for routes R1, R2
• exclude results from agency A2, A3
• exclude results from routes A4, A5 and agencies A4
• ...

Issue

#6239

As discussed in this issue, the schema docs was copied more or less from the Transmodel API and uses the same semantics. Some features like dated service journeys and group of lines, which don't have a GTFS equivalent, are omitted.

Unit tests

Added.

Documentation

Javadoc and schema docs.

[codecov]

Codecov Report

Attention: Patch coverage is 84.40367% with 17 lines in your changes missing coverage. Please review.

Project coverage is 71.39%. Comparing base (fcf784c) to head (b8e0249).
Report is 227 commits behind head on dev-2.x.

Files with missing lines	Patch %	Lines
...ntripplanner/apis/gtfs/generated/GraphQLTypes.java	57.14%	10 Missing and 5 partials ⚠️
...r/apis/gtfs/mapping/routerequest/FilterMapper.java	96.42%	1 Missing ⚠️
...gtfs/mapping/routerequest/SelectRequestMapper.java	93.33%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #6668      +/-   ##
=============================================
+ Coverage      71.38%   71.39%   +0.01%     
- Complexity     18551    18573      +22     
=============================================
  Files           2036     2038       +2     
  Lines          76609    76710     +101     
  Branches        7828     7847      +19     
=============================================
+ Hits           54686    54769      +83     
- Misses         19150    19163      +13     
- Partials        2773     2778       +5     

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

🚀 New features to boost your workflow:

• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[t2gran]

Note! I am not reviewing this, just commented on a few things I noticed while reading through part of the code - core domain only.

[leonardehrenfried]

@fpurcell this might also be relevant for you.

[optionsome]

Was it possible to define these filters in the router configuration? If it is, we probably should expose the defaults in the schema.

[leonardehrenfried]

Was it possible to define these filters in the router configuration? If it is, we probably should expose the defaults in the schema.

We have banned/whitelisted routes and agencies, but their mapping to this structure is a little awkward.

[leonardehrenfried]

Move filters to TransitPreferences

[leonardehrenfried]

While moving the filters into the transit preferences I notices a problem with how they interact with mode settings. I reworked the mapping, added tests and improved the docs.

This is now ready for review.

[leonardehrenfried]

@optionsome I've reworked the documentation a bit.