add StopInPattern in GTFS GraphQL schema

[miklcct]

Summary

This adds a field called stopsInPattern in the Pattern model for the GTFS GraphQL API.

It provides information which cannot be accessed by the existing API, in particular, the board / alight types of stops in a pattern.

Issue

None yet.

Unit tests

The data fetcher code is not tested at all.

I have added a test for the model constructions.

Documentation

Added in GraphQL.

Note that NULL is used for a cancelled PickDrop to be consistent with existing API. It is not possible to change this without breaking backwards compatibility.

[codecov]

Codecov Report

❌ Patch coverage is 63.15789% with 7 lines in your changes missing coverage. Please review.
✅ Project coverage is 72.14%. Comparing base (87cf700) to head (cbddb66).
⚠️ Report is 1 commits behind head on dev-2.x.

Files with missing lines	Patch %	Lines
...ripplanner/apis/gtfs/datafetchers/PatternImpl.java	14.28%	6 Missing ⚠️
...nner/apis/gtfs/datafetchers/StopInPatternImpl.java	83.33%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #6206      +/-   ##
=============================================
- Coverage      72.14%   72.14%   -0.01%     
- Complexity     19673    19677       +4     
=============================================
  Files           2127     2129       +2     
  Lines          79562    79581      +19     
  Branches        8041     8042       +1     
=============================================
+ Hits           57397    57410      +13     
- Misses         19331    19338       +7     
+ Partials        2834     2833       -1     

☔ 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.

[miklcct]

@optionsome We discussed before about the use of Pattern in the API and your use case is to show timetables in the app, which you don't want to take real time stop skipping into account (it modifies the pattern in our internal model).

Are you actually showing the real time timetable (with updated times) on the website, or just the scheduled time? How do you deal with the case if a trip is real time diverted?

[miklcct]

We may need to verify the current API behaviour by making a data set with patterns differing in only the board and alight actions.

[miklcct]

I am republishing this PR for discussion. Our existing GTFS GraphQL API distinguish between patterns which differ only in pickup / drop off and they are listed separately in Stop.stoptimesForPatterns

[optionsome]

I am republishing this PR for discussion. Our existing GTFS GraphQL API distinguish between patterns which differ only in pickup / drop off and they are listed separately in Stop.stoptimesForPatterns

I just checked this and looks like you are correct.

[optionsome]

What do you need this for? Is it just for the index? Isn't it straightforward to compute the index yourself, first item in the list is 0 and so on?

[miklcct]

After the meeting with @t2gran we agreed that adding a link to the new TripOnServiceDate class introduced in #5393 in StopTime will satisfy my use case.

I will mark this as draft now and discuss it with @optionsome on the next developer meeting.