Inject defaults into the planConnection query in the GTFS GraphQL schema #6339

optionsome · 2024-12-17T08:56:36Z

Summary

Inject defaults (either from code or configuration) into the planConnection query in the GTFS GraphQL schema that is outputted through introspection.

This pr also allows to reset searchWindow as null in the planConnection query (in case it has been configured on server).

Issue

No issue

Unit tests

Added tests.

Documentation

In schema

Changelog

From title

Bumping the serialization version id

Not needed

optionsome · 2024-12-17T08:57:53Z

We need to decide if using a directive makes sense or should we just use the input type and field names as keys for the translations. Also, have to maybe figure out how to not construct the schema on each request.

leonardehrenfried · 2024-12-17T10:15:20Z

Can you resolve the conflicts?

We need some defaults from the request

…defaults

optionsome · 2024-12-31T14:43:44Z

application/src/main/java/org/opentripplanner/apis/gtfs/service/SchemaService.java

+ * Service for fetching the {@link GraphQLSchema}. The purpose of this class is to avoid
+ * reconstructing the schema on each request.
+ */
+public class SchemaService {


Is it ok that this is just a class or do we need an interface?

Do we even need it at all? If we make the binding @singleton (you already do that) then there should only be a single instance.

@t2gran mentioned in some developer meeting that this should be put in a service but I agree that the service might add an unnecessary layer here.

Have we decided that we want this?

optionsome · 2024-12-31T14:44:14Z

application/src/main/java/org/opentripplanner/apis/gtfs/SchemaFactory.java

+    } catch (Exception e) {
+      LOG.error("Unable to build GTFS GraphQL Schema", e);
+    }
+    return null;


Should we return null or throw some exception here?

I would throw an exception. Returning null will just cause a more confusing NPE somehwere else.

The schema is built on the first request that comes to the server. I would prefer to build it even before the server starts serving requests so if there is some issue, it could crash the server. Do you have any clue how that could be achieved?

I think you have to call the method eagerly. I believe that Dagger instantiates the dependencies lazily.

What could be a good place to call it eagerly from?

Maybe here?

OpenTripPlanner/application/src/main/java/org/opentripplanner/standalone/configure/ConstructApplication.java

Lines 155 to 159 in 6ae498d

private Application createApplication() {

LOG.info("Wiring up and configuring server.");

setupTransitRoutingServer();

return new OTPWebApplication(routerConfig().server(), this::createServerContext);

}

On the other hand, there is already a unit test so I'm not sure how necessary it is.

codecov · 2024-12-31T14:45:17Z

Codecov Report

Attention: Patch coverage is 89.71429% with 18 lines in your changes missing coverage. Please review.

Project coverage is 69.81%. Comparing base (72019c0) to head (69de270).
Report is 42 commits behind head on dev-2.x.

Files with missing lines	Patch %	Lines
...ner/standalone/configure/ConstructApplication.java	0.00%	6 Missing ⚠️
...a/org/opentripplanner/apis/gtfs/SchemaFactory.java	95.87%	4 Missing ⚠️
...ntripplanner/apis/gtfs/configure/SchemaModule.java	0.00%	4 Missing ⚠️
...pentripplanner/apis/gtfs/DefaultValueInjector.java	96.66%	1 Missing and 1 partial ⚠️
...entripplanner/apis/gtfs/GraphQLRequestContext.java	0.00%	1 Missing ⚠️
...standalone/server/DefaultServerRequestContext.java	50.00%	1 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #6339      +/-   ##
=============================================
+ Coverage      69.79%   69.81%   +0.02%     
- Complexity     17943    17985      +42     
=============================================
  Files           2046     2049       +3     
  Lines          76685    76747      +62     
  Branches        7829     7834       +5     
=============================================
+ Hits           53520    53582      +62     
+ Misses         20423    20422       -1     
- Partials        2742     2743       +1

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

optionsome · 2024-12-31T14:46:10Z

We need to decide if using a directive makes sense or should we just use the input type and field names as keys for the translations. Also, have to maybe figure out how to not construct the schema on each request.

We decided to not use directives (however directive wiring is used to inject the defaults). Used dependency injection to avoid constructing the schema on each request.

…defaults

leonardehrenfried · 2025-01-09T10:48:30Z

...ion/src/main/java/org/opentripplanner/apis/gtfs/mapping/routerequest/RouteRequestMapper.java

@@ -41,11 +41,11 @@ public static RouteRequest toRouteRequest(
    request.setFrom(parseGenericLocation(args.getGraphQLOrigin()));
    request.setTo(parseGenericLocation(args.getGraphQLDestination()));
    request.setLocale(GraphQLUtils.getLocale(environment, args.getGraphQLLocale()));
-    if (args.getGraphQLSearchWindow() != null) {


What is this change for?

leonardehrenfried

If we say that we need the service, I'm fine with it. I don't think it is necessary though.

Draft for injecting defaults into GraphQL schema

c10fb01

optionsome added the Improvement label Dec 17, 2024

optionsome added 12 commits December 17, 2024 15:48

Don't rely on directive for injecting defaults

2c42d14

Use dependency injection for providing GraphQL schema

c51b975

Only construct schema if feature flag is on

f639ce5

Use a slightly prettier method for getting parent name

38b5a5b

Replace preferences with route request

698349e

We need some defaults from the request

Add structure for injecting defaults for arguments and use it for

7162c7a

Add default for search window and allow resetting it to null

280fd45

Add the rest of defaults

45eea03

Fix schema comment about duration being seconds

d298811

Move schema tests to new file

5fe8da8

Add tests for default injection

4f89618

Merge remote-tracking branch 'upstream/dev-2.x' into plan-connection-…

6f4a6fb

…defaults

optionsome marked this pull request as ready for review December 31, 2024 14:43

optionsome requested a review from a team as a code owner December 31, 2024 14:43

optionsome commented Dec 31, 2024

View reviewed changes

optionsome added this to the 2.7 (next release) milestone Dec 31, 2024

optionsome changed the title ~~Add defaults to the planConnection query in the GTFS GraphQL schema~~ Inject defaults into the planConnection query in the GTFS GraphQL schema Dec 31, 2024

optionsome added 2 commits December 31, 2024 16:56

Fix comment

c105fc2

Use schema visitor instead of directive wiring

3beb9be

habrahamsson-skanetrafiken requested a review from t2gran January 7, 2025 10:19

optionsome added 4 commits January 7, 2025 15:05

Initialize schema on server start up

813bbbf

Remove unnecessary annotation

9157359

Split factory method into two versions

7cd815e

Merge remote-tracking branch 'upstream/dev-2.x' into plan-connection-…

3b3d7ff

…defaults

optionsome requested a review from leonardehrenfried January 8, 2025 21:35

Add javadoc

9f72862

leonardehrenfried reviewed Jan 9, 2025

View reviewed changes

Remove service wrapper

f7585cc

optionsome requested a review from leonardehrenfried January 10, 2025 10:26

Fix comment

69de270

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Inject defaults into the planConnection query in the GTFS GraphQL schema #6339

Inject defaults into the planConnection query in the GTFS GraphQL schema #6339

optionsome commented Dec 17, 2024 •

edited

Loading

optionsome commented Dec 17, 2024

leonardehrenfried commented Dec 17, 2024

optionsome Dec 31, 2024

leonardehrenfried Jan 2, 2025

optionsome Jan 3, 2025

leonardehrenfried Jan 9, 2025

optionsome Dec 31, 2024

leonardehrenfried Jan 2, 2025

optionsome Jan 3, 2025

leonardehrenfried Jan 3, 2025

optionsome Jan 3, 2025

leonardehrenfried Jan 3, 2025

leonardehrenfried Jan 3, 2025

codecov bot commented Dec 31, 2024 •

edited

Loading

optionsome commented Dec 31, 2024

leonardehrenfried Jan 9, 2025

leonardehrenfried left a comment

	private Application createApplication() {
	LOG.info("Wiring up and configuring server.");
	setupTransitRoutingServer();
	return new OTPWebApplication(routerConfig().server(), this::createServerContext);
	}

Inject defaults into the planConnection query in the GTFS GraphQL schema #6339

Are you sure you want to change the base?

Inject defaults into the planConnection query in the GTFS GraphQL schema #6339

Conversation

optionsome commented Dec 17, 2024 • edited Loading

Summary

Issue

Unit tests

Documentation

Changelog

Bumping the serialization version id

optionsome commented Dec 17, 2024

leonardehrenfried commented Dec 17, 2024

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Dec 31, 2024 • edited Loading

Codecov Report

optionsome commented Dec 31, 2024

Choose a reason for hiding this comment

leonardehrenfried left a comment

Choose a reason for hiding this comment

optionsome commented Dec 17, 2024 •

edited

Loading

codecov bot commented Dec 31, 2024 •

edited

Loading