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

Remove legacy schema introspection #6139

Merged
merged 10 commits into from
Oct 15, 2024
Merged

Conversation

SimonSapin
Copy link
Contributor

@SimonSapin SimonSapin commented Oct 10, 2024

Schema introspection now runs natively without involving JavaScript code. We have high confidence that the two implementations return matching responses based on differential testing fuzzing arbitrary queries against a large schema, and testing a corpus of customer schemas against a comprehensive query.

In Router YAML configuration:

  • The experimental_introspection_mode key is removed, new is now the only behavior
  • The supergraph.query_planning.legacy_introspection_caching key is removed, the behavior is now similar to what was false: introspection responses are not part of the query plan cache but instead in a separate, small, in-memory only cache.

Migrations ensure that existing configuration files will keep working.

Fixes ROUTER-338


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
  • Existing relevant tests 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 review from a team as code owners October 10, 2024 19:21
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Oct 10, 2024

✅ Docs Preview Ready

No new or changed pages found.

This comment has been minimized.

@lrlna
Copy link
Member

lrlna commented Oct 11, 2024

If introspection is now completely in rust, does that mean v8 won't start up with just experimental_query_planner_mode: new? If so, we need to update a few more docs here and here. It seems the docs we serve are now just on next branch 🤔 🤔 🤔 so I guess doc changes have to be PR'ed separately to next?

@router-perf
Copy link

router-perf bot commented Oct 11, 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

Comment on lines -246 to -254
let js_planner = match self {
Self::Js(js) => js.clone(),
Self::Both { js, .. } => js.clone(),
Self::Rust(_) => {
// JS "planner" (actually runtime) was not created for planning
// but is still needed for introspection, so create it now
Self::js_planner(sdl, configuration, old_js_planner).await?
}
};
Copy link
Contributor Author

Choose a reason for hiding this comment

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

If introspection is now completely in rust, does that mean v8 won't start up with just experimental_query_planner_mode: new?

Correct. This is the relevant code change. Here the badly-named js_planner represents a V8 runtime.

I didn’t realize we publish docs from next, I’ll make a separate PR

@SimonSapin
Copy link
Contributor Author

Docs PR into next: #6149

@@ -959,26 +978,6 @@ async fn query_planner_redis_update_planner_mode() {
.await;
}

#[tokio::test(flavor = "multi_thread")]
async fn query_planner_redis_update_introspection() {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This test is removed because it specifically tests that enabling introspection in config changes Redis cache keys. This PR changes caching_query_planner.rs for this to no longer be the case, since introspection responses (or "introspection is disabled" errors) are now never in this cache.

@SimonSapin SimonSapin changed the title Remove JavaScript-based schema introspection Remove legacy schema introspection Oct 15, 2024
Copy link
Contributor

@Geal Geal left a comment

Choose a reason for hiding this comment

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

thank you, it's great to see that code finally removed!

Comment on lines -613 to -617
<MinVersion version="1.51.0">

### Introspection response caching

</MinVersion>
Copy link
Contributor

Choose a reason for hiding this comment

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

do we have a MaxVersion tag?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not as far as I can see

debug: None,
type_conditioned_fetching: false,
},
fn execute_intropsection(schema: &spec::Schema, doc: &ParsedDocument) -> graphql::Response {
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
fn execute_intropsection(schema: &spec::Schema, doc: &ParsedDocument) -> graphql::Response {
fn execute_introspection(schema: &spec::Schema, doc: &ParsedDocument) -> graphql::Response {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I seem to like that particular typo, I made it in two places

@SimonSapin SimonSapin enabled auto-merge (squash) October 15, 2024 14:06
@SimonSapin SimonSapin merged commit c4fd618 into dev Oct 15, 2024
14 of 15 checks passed
@SimonSapin SimonSapin deleted the simon/replatform-introspection branch October 15, 2024 14:21
@abernix abernix mentioned this pull request Oct 22, 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.

4 participants