Skip to content

Add experimental_query_planner_mode: both_best_effort config#5790

Merged
SimonSapin merged 2 commits intodevfrom
simon/both-with-fallback
Aug 9, 2024
Merged

Add experimental_query_planner_mode: both_best_effort config#5790
SimonSapin merged 2 commits intodevfrom
simon/both-with-fallback

Conversation

@SimonSapin
Copy link
Copy Markdown
Contributor

Some supergraph schemas supported by current Router versions (notably those using Apollo Federation 1) are not supported by the new Rust query planner. When a user explicitly configures experimental_query_planner_mode: new or experimental_query_planner_mode: both, we want unsupported schemas to cause an error at Router startup in order to make the issue very visible.

This adds experimental_query_planner_mode: both_best_effort which is like both whenever possible, and silently falls back to legacy otherwise. This behavior makes it suitable to potentially become the new default config.

Fixes ROUTER-601


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

@SimonSapin SimonSapin requested a review from a team August 8, 2024 14:29
@SimonSapin SimonSapin requested a review from a team as a code owner August 8, 2024 14:29
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 8, 2024

@SimonSapin, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

@router-perf
Copy link
Copy Markdown

router-perf bot commented Aug 8, 2024

CI performance tests

  • const - Basic stress test that runs with a constant number of users
  • demand-control-instrumented - A copy of the step test, but with demand control monitoring and metrics enabled
  • demand-control-uninstrumented - A copy of the step test, but with demand control monitoring enabled
  • enhanced-signature - Enhanced signature enabled
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • events_big_cap_high_rate_callback - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity using callback mode
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • extended-reference-mode - Extended reference mode enabled
  • large-request - Stress test with a 1 MB request payload
  • no-tracing - Basic stress test, no tracing
  • reload - Reload test over a long period of time at a constant rate of users
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • step-local-metrics - Field stats that are generated from the router rather than FTV1
  • step-with-prometheus - A copy of the step test with the Prometheus metrics exporter enabled
  • step - Basic stress test that steps up the number of users over time
  • xlarge-request - Stress test with 10 MB request payload
  • xxlarge-request - Stress test with 100 MB request payload

Comment on lines +162 to +165
QueryPlannerMode::BothBestEffort => match Self::rust(schema, configuration) {
Ok(planner) => Ok(Some(planner)),
Err(_) => Ok(None),
},
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes fallback completely silent. Should we log a warning instead?

Copy link
Copy Markdown
Member

@goto-bus-stop goto-bus-stop Aug 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it'd be nice to warn for fed 1 (since it's a future compatibility issue), but maybe not for Rust QP bugs or missing features

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems unlike that constructing the Rust QP would fail in places that the JS QP doesn't. If we were to log errors here, what would we want to log?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a tracing::warn! call and a test for it

@SimonSapin SimonSapin enabled auto-merge (squash) August 9, 2024 15:34
@SimonSapin SimonSapin merged commit 5421580 into dev Aug 9, 2024
@SimonSapin SimonSapin deleted the simon/both-with-fallback branch August 9, 2024 15:46
@abernix abernix mentioned this pull request Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants