Skip to content

Remove the legacy query planner#6418

Merged
SimonSapin merged 11 commits intodevfrom
simon/unbridge
Dec 12, 2024
Merged

Remove the legacy query planner#6418
SimonSapin merged 11 commits intodevfrom
simon/unbridge

Conversation

@SimonSapin
Copy link
Contributor

@SimonSapin SimonSapin commented Dec 9, 2024

The legacy query planner has been removed in this release. In the previous release, Router 1.58, it was already no longer used by default but it was still available through the experimental_query_planner_mode configuration key. That key is now removed.

Also removed are configuration keys which were only relevant to the legacy planner:

  • supergraph.query_planning.experimental_parallelism: the new planner can always use available parallelism.
  • supergraph.experimental_reuse_query_fragments: this experimental algorithm that attempted to
    reuse fragments from the original operation while forming subgraph requests is no longer present. Instead, by default new fragment definitions are generated based on the shape of the subgraph operation.

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.

@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Dec 9, 2024

✅ Docs Preview Ready

No new or changed pages found.

@github-actions

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented Dec 9, 2024

CI performance tests

  • connectors-const - Connectors stress test that runs with a constant number of users
  • 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

@samuelAndalon
Copy link
Contributor

samuelAndalon commented Dec 9, 2024

This is a step forward to the avoid global warmth that JS is causing.

image

@SimonSapin
Copy link
Contributor Author

This is ready for review but should only be merged after we branch 1.59 later this week.

@SimonSapin SimonSapin marked this pull request as ready for review December 10, 2024 09:39
@SimonSapin SimonSapin requested a review from a team December 10, 2024 09:39
@SimonSapin SimonSapin requested review from a team as code owners December 10, 2024 09:39
Copy link
Member

@lrlna lrlna left a comment

Choose a reason for hiding this comment

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

Potentially the most exciting PR in router's history! 🎉

Leaving some initial comments.

Error: Cannot find type "Review" in subgraph "products"
caused by
"#
Details: Object field "Product.reviews"'s inner type "Review" does not refer to an existing output type."#
Copy link
Member

Choose a reason for hiding this comment

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

🤔 is this an issue that the error message is very different?

let config = format!("{PROMETHEUS_METRICS_CONFIG}\n{NEW_QP}");
let mut router = IntegrationTest::builder()
.config(config)
.config(PROMETHEUS_METRICS_CONFIG)
Copy link
Member

Choose a reason for hiding this comment

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

should we just drop this test? i think this file can just have the fed1 tests and that's it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The apollo.router.lifecycle.query_planner.init metric still exists and is tested here. Should we also remove it?

Copy link
Member

Choose a reason for hiding this comment

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

Hmmm, no we should track that metric for the time being - specifically for fed 1 supergraph fall backs that get added to ...query_planner.init.

Copy link
Contributor

@garypen garypen left a comment

Choose a reason for hiding this comment

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

This looks great! We should follow up at some point with some renaming of BridgeQueryPlanner bits and I think we could completely delete BridgeQueryPlannerPool.

@SimonSapin SimonSapin merged commit 232f40d into dev Dec 12, 2024
@SimonSapin SimonSapin deleted the simon/unbridge branch December 12, 2024 12:51
@SimonSapin SimonSapin mentioned this pull request Dec 12, 2024
6 tasks
SimonSapin added a commit that referenced this pull request Dec 12, 2024
* cmake is no longer required to build Router since #6418
* nodejs hasen’t been required for much longer: router-bridge shipped with a pre-built V8 "bundle"
* xtask is a pattern not a singular tool: <https://crates.io/crates/cargo-xtask> is just a placeholder so `cargo install cargo-xtask` does nothing
@abernix abernix mentioned this pull request Feb 5, 2025
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.

6 participants