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

feat(federation): respect the subgraph_graphql_validation option #5871

Closed
wants to merge 2 commits into from

Conversation

duckki
Copy link
Contributor

@duckki duckki commented Aug 23, 2024

  • validate subgraph queries only when subgraph_graphql_validation configuration option is true.

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.

- when `subgraph_graphql_validation` configuration option is true.
Copy link
Contributor

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

@router-perf
Copy link

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

@duckki duckki changed the title feat: respect the subgraph_graphql_validation option feat(federation): respect the subgraph_graphql_validation option Aug 23, 2024
Copy link
Member

@goto-bus-stop goto-bus-stop left a comment

Choose a reason for hiding this comment

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

Tbh, I have a slight preference for always validating, and returning an internal error if we produced an invalid query.

@@ -3955,7 +3955,7 @@ impl TryFrom<Operation> for Valid<executable::ExecutableDocument> {
document.fragments = fragments;
document.operations.insert(operation);
coerce_executable_values(value.schema.schema(), &mut document);
Ok(document.validate(value.schema.schema())?)
Ok(Valid::assume_valid(document))
Copy link
Member

@goto-bus-stop goto-bus-stop Aug 23, 2024

Choose a reason for hiding this comment

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

We should not do assume_valid inside this TryFrom implementation. If we do this we should change the impl to TryFrom<Operation> for executable::ExecutableDocument.

@duckki
Copy link
Contributor Author

duckki commented Aug 23, 2024

JS QP doesn't seem to validate subgraph queries. So, Rust QP is taking a performance penalty (didn't measure how much). Also, this validation has never failed so far over the corpus.

@duckki
Copy link
Contributor Author

duckki commented Aug 23, 2024

This is not urgent. We can revisit this when we work on performance.

@duckki duckki force-pushed the duckki/subgraph-query-validation branch from 570ad0f to c10afff Compare August 23, 2024 16:39
@duckki duckki marked this pull request as draft October 29, 2024 03:29
@abernix
Copy link
Member

abernix commented Nov 25, 2024

Closing this to clean-up some open and aging PRs, but don't hesitate to just click the re-open button it if it's still relevant.

@abernix abernix closed this Nov 25, 2024
@duckki duckki deleted the duckki/subgraph-query-validation branch January 19, 2025 01:46
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.

3 participants