Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract @cost and @listSize to query planner's subgraph schemas #5707

Merged
merged 14 commits into from
Aug 5, 2024

Conversation

tninesling
Copy link
Contributor

@tninesling tninesling commented Jul 22, 2024

This PR follows up on apollographql/federation#3074, which defined the new @cost and @listSize directives. These will be used by the demand control plugin to score the cost of operations. In the scoring algorithm, the plugin scores FetchNodes in the query plan based on their respective subgraph schemas. This means those extracted subgraph schemas must include these directives, which are copied over from the supergraph.


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.

Copy link
Contributor

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

@router-perf
Copy link

router-perf bot commented Jul 22, 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

@lrlna lrlna self-assigned this Jul 30, 2024
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.

This is looking good! Thank you for making sure it's right away added to the rust implementation!

The only change I'd like to ask for is adding Object and Scalar types with @cost to the two tests you've got here. Otherwise a few clarification comments/questions.

@lrlna
Copy link
Member

lrlna commented Aug 2, 2024

I am away this next week and don’t want to block you from merging this. The only thing that's important before merging is using the Object Type Definition and the Scalar Type Definiton with @cost in a test.

@tninesling
Copy link
Contributor Author

I am away this next week and don’t want to block you from merging this. The only thing that's important before merging is using the Object Type Definition and the Scalar Type Definiton with @cost in a test.

Thanks, Iryna. This was a great catch, and made me realize I need an equivalent patch for the JS version

@tninesling tninesling merged commit 8b9b1a3 into dev Aug 5, 2024
14 checks passed
@tninesling tninesling deleted the tninesling/cost-extraction-without-join branch August 5, 2024 15:26
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