Skip to content

Share a single Rust QP instance when using a pool of JS workers#5771

Merged
SimonSapin merged 1 commit intodevfrom
simon/shared-rust-qp-in-pool
Aug 5, 2024
Merged

Share a single Rust QP instance when using a pool of JS workers#5771
SimonSapin merged 1 commit intodevfrom
simon/shared-rust-qp-in-pool

Conversation

@SimonSapin
Copy link
Contributor

Config supergraph.query_planning.experimental_parallelism defaults to 1, but when set to something else BridgeQueryPlannerPool creates that many instances of BridgeQueryPlanner which in turn create a JS worker each.

If config experimental_query_planner_mode is also set to new or both (current default is legacy), the each BridgeQueryPlanner would also unnecessarily create its own instance of the Rust QueryPlanner struct.

Instead, a single QueryPlanner is now shared with Arc. Unlike JS workers, QueryPlanner only contains read-only data and can safely be shared between threads. This should reduce memory use when both supergraph.query_planning.experimental_parallelism and experimental_query_planner_mode are configured to non-default values.


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.

Config `supergraph.query_planning.experimental_parallelism` defaults to 1,
but when set to something else `BridgeQueryPlannerPool` creates that many
instances of `BridgeQueryPlanner` which in turn create a JS worker each.

If config `experimental_query_planner_mode` is also set to `new` or `both`
(current default is `legacy`), the each `BridgeQueryPlanner` would also
unnecessarily create its own instance of the Rust `QueryPlanner` struct.

Instead, a single `QueryPlanner` is now shared with `Arc`.
Unlike JS workers, `QueryPlanner` only contains read-only data
and can safely be shared between threads.
@SimonSapin SimonSapin requested a review from a team August 5, 2024 11:48
@SimonSapin SimonSapin requested a review from a team as a code owner August 5, 2024 11:48
@github-actions
Copy link
Contributor

github-actions bot commented Aug 5, 2024

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

@router-perf
Copy link

router-perf bot commented Aug 5, 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

@SimonSapin SimonSapin requested a review from TylerBloom August 5, 2024 11:51
Copy link
Contributor

@TylerBloom TylerBloom left a comment

Choose a reason for hiding this comment

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

LGTM

@SimonSapin SimonSapin merged commit c30de6e into dev Aug 5, 2024
@SimonSapin SimonSapin deleted the simon/shared-rust-qp-in-pool branch August 5, 2024 15:28
@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.

2 participants