New spec validation: Subscriptions root field must not contain @skip nor @include on root selection set #3871
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,154 @@ | ||
| package graphql.validation.rules | ||
|
|
||
| import graphql.parser.Parser | ||
| import graphql.validation.SpecValidationSchema | ||
| import graphql.validation.ValidationError | ||
| import graphql.validation.Validator | ||
| import spock.lang.Specification | ||
|
|
||
| class SubscriptionRootFieldNoSkipNoIncludeTest extends Specification { | ||
|
|
||
| def "valid subscription with @skip and @include directives on subfields"() { | ||
| given: | ||
| def query = """ | ||
| subscription MySubscription(\$bool: Boolean = true) { | ||
|
Member
Author
There was a problem hiding this comment. This is what I mean by default values. When an empty coerced variables map is passed, this test fails |
||
| dog { | ||
| name @skip(if: \$bool) | ||
| nickname @include(if: \$bool) | ||
| } | ||
| } | ||
| """ | ||
|
|
||
| when: | ||
| def validationErrors = validate(query) | ||
|
|
||
| then: | ||
| validationErrors.isEmpty() | ||
| } | ||
|
|
||
| def "invalid subscription with @skip directive on root field"() { | ||
| given: | ||
| def query = """ | ||
| subscription MySubscription(\$bool: Boolean = false) { | ||
| dog @skip(if: \$bool) { | ||
| name | ||
| } | ||
| dog @include(if: true) { | ||
| nickname | ||
| } | ||
| } | ||
| """ | ||
|
|
||
| when: | ||
| def validationErrors = validate(query) | ||
|
|
||
| then: | ||
| validationErrors.size() == 1 | ||
| validationErrors.first().getMessage().contains("Subscription operation 'MySubscription' root field 'dog' must not use @skip nor @include directives in top level selection") | ||
| } | ||
|
|
||
| def "invalid subscription with @include directive on root field"() { | ||
| given: | ||
| def query = """ | ||
| subscription MySubscription(\$bool: Boolean = true) { | ||
| dog @include(if: \$bool) { | ||
| name | ||
| } | ||
| } | ||
| """ | ||
|
|
||
| when: | ||
| def validationErrors = validate(query) | ||
|
|
||
| then: | ||
| validationErrors.size() == 1 | ||
| validationErrors.first().getMessage().contains("Subscription operation 'MySubscription' root field 'dog' must not use @skip nor @include directives in top level selection") | ||
| } | ||
|
|
||
| def "invalid subscription with directive on root field in fragment spread"() { | ||
| given: | ||
| def query = """ | ||
| subscription MySubscription(\$bool: Boolean = false) { | ||
| ...dogFragment | ||
| } | ||
|
|
||
| fragment dogFragment on SubscriptionRoot { | ||
| dog @skip(if: \$bool) { | ||
| name | ||
| } | ||
| } | ||
| """ | ||
|
|
||
| when: | ||
| def validationErrors = validate(query) | ||
|
|
||
| then: | ||
| validationErrors.size() == 1 | ||
| validationErrors.first().getMessage().contains("Subscription operation 'MySubscription' root field 'dog' must not use @skip nor @include directives in top level selection") | ||
| } | ||
|
|
||
| def "invalid subscription with directive on root field in inline fragment"() { | ||
| given: | ||
| def query = """ | ||
| subscription MySubscription(\$bool: Boolean = true) { | ||
| ... on SubscriptionRoot { | ||
| dog @include(if: \$bool) { | ||
| name | ||
| } | ||
| } | ||
| } | ||
| """ | ||
|
|
||
| when: | ||
| def validationErrors = validate(query) | ||
|
|
||
| then: | ||
| validationErrors.size() == 1 | ||
| validationErrors.first().getMessage().contains("Subscription operation 'MySubscription' root field 'dog' must not use @skip nor @include directives in top level selection") | ||
| } | ||
|
|
||
| def "@skip and @include directives are valid on query root fields"() { | ||
| given: | ||
| def query = """ | ||
| query MyQuery { | ||
| pet @skip(if: false) { | ||
| name | ||
| } | ||
| pet @include(if: true) { | ||
| name | ||
| } | ||
| } | ||
| """ | ||
|
|
||
| when: | ||
| def validationErrors = validate(query) | ||
|
|
||
| then: | ||
| validationErrors.size() == 0 | ||
| } | ||
|
|
||
| def "@skip and @include directives are valid on mutation root fields"() { | ||
| given: | ||
| def query = """ | ||
| mutation MyMutation { | ||
| createDog(input: {id: "a"}) @skip(if: false) { | ||
| name | ||
| } | ||
| createDog(input: {id: "a"}) @include(if: true) { | ||
| name | ||
| } | ||
| } | ||
| """ | ||
|
|
||
| when: | ||
| def validationErrors = validate(query) | ||
|
|
||
| then: | ||
| validationErrors.size() == 0 | ||
| } | ||
|
|
||
| static List<ValidationError> validate(String query) { | ||
| def document = new Parser().parseDocument(query) | ||
| return new Validator().validateDocument(SpecValidationSchema.specValidationSchema, document, Locale.ENGLISH) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed this rule name to be more generic, reflecting that it does 2 checks on the root field