Refetch transit leg with a leg query of GTFS GraphQL API #6045

vesameskanen · 2024-09-05T10:42:58Z

Summary

GTFS leg object now includes a graphql node id . Transit leg can be refetched using a new leg query:

query legQuery { leg(id: "foo") { mode start { estimated { time } } } }

Such query can be used to update an itinerary and to detect if the itinerary is no longer possible because of delays or canceled trips.

Non-transit legs cannot be refetched - the response is always null.

This PR also adds missing implementation for querying leg's realtimeState via GTFS graphql API.

Documentation

In the graphql schema.

leonardehrenfried · 2024-09-05T10:47:22Z

@binh-dam-ibigroup This might be interesting for you.

@vesameskanen I almost cannot believe that it is so easy!

codecov · 2024-09-05T10:54:54Z

Codecov Report

Attention: Patch coverage is 48.14815% with 14 lines in your changes missing coverage. Please review.

Project coverage is 69.83%. Comparing base (c022422) to head (857b815).
Report is 71 commits behind head on dev-2.x.

Files with missing lines	Patch %	Lines
...pplanner/apis/gtfs/datafetchers/QueryTypeImpl.java	12.50%	7 Missing ⚠️
...ntripplanner/apis/gtfs/generated/GraphQLTypes.java	0.00%	7 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #6045      +/-   ##
=============================================
+ Coverage      69.81%   69.83%   +0.01%     
- Complexity     17418    17460      +42     
=============================================
  Files           1974     1975       +1     
  Lines          74537    74624      +87     
  Branches        7633     7638       +5     
=============================================
+ Hits           52040    52115      +75     
- Misses         19847    19857      +10     
- Partials        2650     2652       +2

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

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/QueryTypeImpl.java

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

optionsome · 2024-09-05T12:23:51Z

@vesameskanen I almost cannot believe that it is so easy!

This is easy because this was already done in the transmodel API. However, the transmodel API has own legs query for this because it lacks the node query/interface.

optionsome · 2024-09-05T12:26:14Z

@vesameskanen will still add some integration tests for this.

vesameskanen · 2024-09-06T08:19:56Z

GTFS integration tests currently cannot test leg refetching, because mocked itineraries lack essential data used in encoding the leg information. Integration test now tests only that legs contain the id.

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/LegImpl.java

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

Also, move all encoding/decoding logig to LegReferenceSerializer class.

src/main/java/org/opentripplanner/model/plan/legreference/LegReferenceSerializer.java

vesameskanen · 2024-09-11T11:19:14Z

I tested new legs with relay and got lots of problems. Relay does not accept nodes with same node id but different content. Either all leg types must be serialized to unique id ('NotAvailable' is not OK), or we have to revert node interface for legs and add a dedicated leg query. Any opinions?

leonardehrenfried · 2024-09-11T13:35:33Z

Maybe I don't get it but don't all legs have the same type in GraphQL?

optionsome · 2024-09-12T07:55:47Z

Maybe I don't get it but don't all legs have the same type in GraphQL?

@vesameskanen explained to me that the issue is that the non-transit legs all have the same id. We discussed this today and thought maybe the solution would be to generate unique ids based on actual leg data (such as departure/arrival time) even if we don't support refetching based on those ids.

I tried adding tests for refetching the legs through the node query in the graphql integration tests on Tuesday but creating/maintaining such test would be slightly difficult.

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/NodeTypeResolver.java

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

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

…-leg-node-refetch

optionsome

We might need to discuss my suggestion in a developer meeting. Idk if we should give entities global ids even if they are not refetchable with a node query. I think at least in netex, the ids are always unique and have the type in the id (if I'm not mistaken).

optionsome · 2024-09-26T08:47:59Z

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/LegImpl.java

+  public DataFetcher<Relay.ResolvedGlobalId> id() {
+    return environment -> {
+      var ref = getSource(environment).getLegReference();
+      if (ref == null) {
+        return null;
+      }
+      var id = LegReferenceSerializer.encode(ref);
+      return new Relay.ResolvedGlobalId("Leg", id);
+    };


I don't think we should use the global id anymore, since we have own query for this now, we can just return a string which is the output of the LegReferenceSerializer.encode(ref).

Using plain string is indeed simpler. Changed.

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

optionsome · 2024-09-26T09:27:10Z

I think since the leg reference has "SCHEDULED_TRANSIT_LEG_V3" in the id (example base64 decoded id ��wh��SCHEDULED_TRANSIT_LEG_V3��HSL:3002Y_20240801_To_1_1223� 2024-09-26��HSL:1174504��HSL:2611502��), I don't think it's necessary to prefix the id with "Leg" but since it's a small effort, we can still discuss this in the dev meeting.

optionsome · 2024-09-26T13:31:41Z

We decided to just use the LegReferenceSerializer.encode(ref) as is instead of encoding it again with the relay library. The id can be a String in the schema.

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/LegImpl.java

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

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

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

leonardehrenfried · 2024-09-27T07:46:55Z

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/LegImpl.java

@@ -189,10 +190,12 @@ public DataFetcher<Boolean> realTime() {
    return environment -> getSource(environment).getRealTime();
  }

-  // TODO
  @Override
  public DataFetcher<String> realtimeState() {


I just realised that this doesn't use a proper mapper, which I think is a very useful thing.

Since I already approved, I wrote the code myself: leonardehrenfried@a763bc5

If you want you can cherry pick it into this PR.

Ah, too late. I will open another one myself.

miklcct · 2024-10-10T14:18:43Z

My GTFS has an original_trip_id in addition to trip_id. If there is a timetable change affecting only a few days in the original calendar, a new trip_id has to be generated because it must be unique, however the original_trip_id field is the same.

In this case, can it be used to fetch the updated timetable?

vesameskanen added 3 commits September 3, 2024 12:06

GTFS graphql API supports querying itinerary leg status

5e18c0a

Catch non-transit legs properly

021e07c

Add type resolver for Leg

01b460d

vesameskanen requested a review from a team as a code owner September 5, 2024 10:42

leonardehrenfried changed the title ~~Add support for refetching transit leg using the node query of GTFS graphql API~~ Refetch transit leg with node query of GTFS Graphql API Sep 5, 2024

leonardehrenfried changed the title ~~Refetch transit leg with node query of GTFS Graphql API~~ Refetch transit leg with node query of GTFS GraphQL API Sep 5, 2024

Fix formatting

2182066

leonardehrenfried reviewed Sep 5, 2024

View reviewed changes

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/QueryTypeImpl.java Outdated Show resolved Hide resolved

leonardehrenfried reviewed Sep 5, 2024

View reviewed changes

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls Outdated Show resolved Hide resolved

vesameskanen added 3 commits September 6, 2024 08:57

Do not encode null reference as 'null' string

7e2033f

More accurate docs about leg query

6b92741

Add leg id to plan query test

e489f05

optionsome reviewed Sep 6, 2024

View reviewed changes

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/LegImpl.java Outdated Show resolved Hide resolved

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls Outdated Show resolved Hide resolved

vesameskanen added 2 commits September 9, 2024 09:48

Use self-documenting value for non-transit leg ids

6bd5d04

Also, move all encoding/decoding logig to LegReferenceSerializer class.

Add more docs about leg re-fetching into gtfs graphql schema

a998e52

optionsome reviewed Sep 9, 2024

View reviewed changes

src/main/java/org/opentripplanner/model/plan/legreference/LegReferenceSerializer.java Outdated Show resolved Hide resolved

vesameskanen added 2 commits September 11, 2024 08:33

Support querying leg's realTimeState in GTFS graphql api

cf37e89

Query realtimeState in extended plan test

cd54cbe

vesameskanen marked this pull request as draft September 11, 2024 11:15

vesameskanen added 3 commits September 13, 2024 08:23

Revert LegReferenceSerializer changes

4025d5b

Generate unique id for non-transit legs

b206ce1

Restore LegReferenceSerializer null test

15f1f34

leonardehrenfried reviewed Sep 25, 2024

View reviewed changes

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/NodeTypeResolver.java Outdated Show resolved Hide resolved

leonardehrenfried reviewed Sep 25, 2024

View reviewed changes

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls Outdated Show resolved Hide resolved

vesameskanen changed the title ~~Refetch transit leg with node query of GTFS GraphQL API~~ Refetch transit leg with a leg query of GTFS GraphQL API Sep 26, 2024

vesameskanen and others added 3 commits September 26, 2024 08:23

Update src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

58b382f

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

Suggested review changes

f6a8d8f

Merge remote-tracking branch 'origin/gfts-leg-node-refetch' into gfts…

71caaa5

…-leg-node-refetch

vesameskanen requested review from leonardehrenfried and optionsome September 26, 2024 06:07

leonardehrenfried previously approved these changes Sep 26, 2024

View reviewed changes

optionsome reviewed Sep 26, 2024

View reviewed changes

Use string type instead of relay ID type for transit leg identification

ba100e8

vesameskanen dismissed leonardehrenfried’s stale review via ba100e8 September 27, 2024 05:17

vesameskanen requested review from optionsome and leonardehrenfried September 27, 2024 05:23

leonardehrenfried previously approved these changes Sep 27, 2024

View reviewed changes

optionsome reviewed Sep 27, 2024

View reviewed changes

src/main/java/org/opentripplanner/apis/gtfs/datafetchers/LegImpl.java Outdated Show resolved Hide resolved

src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls Outdated Show resolved Hide resolved

Update src/main/java/org/opentripplanner/apis/gtfs/datafetchers/LegIm…

45d6f98

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

vesameskanen dismissed leonardehrenfried’s stale review via 45d6f98 September 27, 2024 07:14

Update src/main/resources/org/opentripplanner/apis/gtfs/schema.graphqls

857b815

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

optionsome approved these changes Sep 27, 2024

View reviewed changes

leonardehrenfried approved these changes Sep 27, 2024

View reviewed changes

vesameskanen merged commit 2cfbd7b into opentripplanner:dev-2.x Sep 27, 2024
5 checks passed

vesameskanen deleted the gfts-leg-node-refetch branch September 27, 2024 07:46

leonardehrenfried reviewed Sep 27, 2024

View reviewed changes

t2gran pushed a commit that referenced this pull request Sep 27, 2024

Add changelog entry for #6045 [ci skip]

69a5ff1

leonardehrenfried mentioned this pull request Sep 27, 2024

Add mapper for GTFS GraphQL real time state #6099

Merged

vesameskanen mentioned this pull request Nov 4, 2024

Leg id causes fare conflicts because of relay conventions #6222

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refetch transit leg with a leg query of GTFS GraphQL API #6045

Refetch transit leg with a leg query of GTFS GraphQL API #6045

vesameskanen commented Sep 5, 2024 •

edited

Loading

leonardehrenfried commented Sep 5, 2024

codecov bot commented Sep 5, 2024 •

edited

Loading

optionsome commented Sep 5, 2024

optionsome commented Sep 5, 2024

vesameskanen commented Sep 6, 2024 •

edited

Loading

vesameskanen commented Sep 11, 2024 •

edited

Loading

leonardehrenfried commented Sep 11, 2024 •

edited

Loading

optionsome commented Sep 12, 2024

optionsome left a comment

optionsome Sep 26, 2024

vesameskanen Sep 27, 2024

optionsome commented Sep 26, 2024

optionsome commented Sep 26, 2024

leonardehrenfried Sep 27, 2024

leonardehrenfried Sep 27, 2024

miklcct commented Oct 10, 2024

Refetch transit leg with a leg query of GTFS GraphQL API #6045

Refetch transit leg with a leg query of GTFS GraphQL API #6045

Conversation

vesameskanen commented Sep 5, 2024 • edited Loading

Summary

Documentation

leonardehrenfried commented Sep 5, 2024

codecov bot commented Sep 5, 2024 • edited Loading

Codecov Report

optionsome commented Sep 5, 2024

optionsome commented Sep 5, 2024

vesameskanen commented Sep 6, 2024 • edited Loading

vesameskanen commented Sep 11, 2024 • edited Loading

leonardehrenfried commented Sep 11, 2024 • edited Loading

optionsome commented Sep 12, 2024

optionsome left a comment

Choose a reason for hiding this comment

optionsome Sep 26, 2024

Choose a reason for hiding this comment

vesameskanen Sep 27, 2024

Choose a reason for hiding this comment

optionsome commented Sep 26, 2024

optionsome commented Sep 26, 2024

leonardehrenfried Sep 27, 2024

Choose a reason for hiding this comment

leonardehrenfried Sep 27, 2024

Choose a reason for hiding this comment

miklcct commented Oct 10, 2024

vesameskanen commented Sep 5, 2024 •

edited

Loading

codecov bot commented Sep 5, 2024 •

edited

Loading

vesameskanen commented Sep 6, 2024 •

edited

Loading

vesameskanen commented Sep 11, 2024 •

edited

Loading

leonardehrenfried commented Sep 11, 2024 •

edited

Loading