-
Notifications
You must be signed in to change notification settings - Fork 9
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
Adds Input Field Default Mismatch Rule #46
Open
michaelstaib
wants to merge
1
commit into
main
Choose a base branch
from
mst/InputFieldDefaultMismatch
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -14,6 +14,77 @@ run in sequence to produce the composite execution schema. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
### Pre Merge Validation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
#### Input Field Default Mismatch | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
**Error Code** | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
`Input_Field_Default_Mismatch` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
**Formal Specification** | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- Let {inputFieldsByName} be a map where the key is the name of an input field | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
and the value is a list of input fields from different source schemas from the same | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type with the same name. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- For each {inputFields} in {inputFieldsByName}: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- Let {defaultValues} be a set containing the default values of each input | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
field in {inputFields}. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- If the size of {defaultValues} is greater than | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Greater than what? 🙂 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- {InputFieldsHaveConsistentDefaults(inputFields)} must be false. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
InputFieldsHaveConsistentDefaults(inputFields): | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- Given each pair of input fields {inputFieldA} and {inputFieldB} in | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{inputFields}: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- If the default value of {inputFieldA} is not equal to the default value of | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{inputFieldB}: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- return false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
- return true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
**Explanatory Text** | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Input fields in different source schemas that have the same name are required to have | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
consistent default values. This ensures that there is no ambiguity or | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
inconsistency when merging schemas from different source schemas. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A mismatch in default values for input fields with the same name across | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
different source schemas will result in a schema composition error. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
In the the following example both source schemas have an input field `field1` with | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
the same default value. This is valid: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
```graphql example | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
input Filter { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
field1: Enum1 = Value1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enum Enum1 { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Value1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Value2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
input Filter { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
field1: Enum1 = Value1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
enum Enum1 { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Value1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Value2 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Comment on lines
+56
to
+72
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
In the following example both source schemas define an input field `field1` with | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
different default values. This is invalid: | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
```graphql counter-example | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
input Filter { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
field1: Int = 10 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
input Filter { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
field1: Int = 20 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
``` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
### Merge | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
### Post Merge Validation | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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.