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

reuse cached query plans across schema updates if possible #4883

Merged
merged 26 commits into from
Apr 4, 2024

Conversation

Geal
Copy link
Contributor

@Geal Geal commented Mar 28, 2024

Fix #4834

This extends the schema aware hashing already used for subgraph queries in entity caching, to be usable for client queries, and use that hash in the query planner cache to be able to reuse cached entries across schema reloads.
This contains:

  • an update of the traverse visitor to use an ExecutableDocument (necessary to parse field sets in key and requires argument
  • parses field sets in @join__type's key argument and @join__field's requires argument, because they can be affected by schema updates
  • remove the hack around _entities operation
  • parse subgraph queries using the subgraph schemas extracted from the supergraph schema
  • update query planner cache warm up to check if the query hash changed

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.

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented Mar 28, 2024

CI performance tests

  • reload - Reload test over a long period of time at a constant rate of users
  • 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_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • large-request - Stress test with a 1 MB request payload
  • const - Basic stress test that runs with a constant number of users
  • no-graphos - Basic stress test, no GraphOS.
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • 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_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • xxlarge-request - Stress test with 100 MB request payload
  • xlarge-request - Stress test with 10 MB request payload
  • step - Basic stress test that steps up the number of users over time

@Geal Geal changed the title take the key and requires into account in the schema hash reuse cached query plans across schema updates if possible Apr 3, 2024
@Geal Geal marked this pull request as ready for review April 3, 2024 14:09
@Geal Geal requested a review from a team as a code owner April 3, 2024 15:19
@goto-bus-stop goto-bus-stop self-requested a review April 3, 2024 15:27
@Geal
Copy link
Contributor Author

Geal commented Apr 3, 2024

feedback from @bnjjj off band: we should make it available via an option, so users can roll it back if we find an issue

@Geal Geal force-pushed the geal/schema-hash-requires branch from 2c4c3e2 to 789c8b2 Compare April 3, 2024 16:07
@Geal Geal merged commit 3b08805 into dev Apr 4, 2024
14 checks passed
@Geal Geal deleted the geal/schema-hash-requires branch April 4, 2024 12:19
@Geal Geal mentioned this pull request Apr 11, 2024
6 tasks
abernix pushed a commit that referenced this pull request Apr 25, 2024
Fix #5006

in #4883 we introduced a
query hashing scheme that stays stable across schema updates if the
update does not affect the query. Unfortunately, it was not taking
introspection queries into account.
This fixes the hashing mechanism to add the schema string to hashed data
if we encounter an introspection field. This is a temporary fix until we
move introspection execution out of query planning. At that point, this
hashing mechanism won't ever see introspection fields.
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.

Entity cache: query hashing should take requires and provides into account
2 participants