-
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 Types mergeable validation rule #45
Open
michaelstaib
wants to merge
8
commits into
main
Choose a base branch
from
mst/InputFieldMergable
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
Show all changes
8 commits
Select commit
Hold shift + click to select a range
69e397c
Adds Input Field Types mergeable validation rule
michaelstaib 1f09a63
format
michaelstaib cf671c3
wip
michaelstaib ed14a7e
wip
michaelstaib d4e2cb2
wip
michaelstaib 91258ef
Update spec/Section 4 -- Composition.md
michaelstaib c3f578c
Update spec/Section 4 -- Composition.md
michaelstaib 35ada33
Update spec/Section 4 -- Composition.md
michaelstaib 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,82 @@ run in sequence to produce the composite execution schema. | |||||||||
|
||||||||||
### Pre Merge Validation | ||||||||||
|
||||||||||
#### Input Field Types mergeable | ||||||||||
|
||||||||||
**Error Code** | ||||||||||
|
||||||||||
`INPUT_FIELD_TYPES_NOT_MERGEABLE` | ||||||||||
|
||||||||||
**Formal Specification** | ||||||||||
|
||||||||||
- Let {fieldsByName} be a map of field lists where the key is the name of a | ||||||||||
field and the value is a list of fields from mergeable input types from | ||||||||||
different source schemas with the same name. | ||||||||||
- For each {fields} in {fieldsByName}: | ||||||||||
- {InputFieldsAreMergeable(fields)} must be true. | ||||||||||
|
||||||||||
InputFieldsAreMergeable(fields): | ||||||||||
|
||||||||||
- Given each pair of members {fieldA} and {fieldB} in {fields}: | ||||||||||
- Let {typeA} be the type of {fieldA}. | ||||||||||
- Let {typeB} be the type of {fieldB}. | ||||||||||
- {SameTypeShape(typeA, typeB)} must be true. | ||||||||||
|
||||||||||
**Explanatory Text** | ||||||||||
|
||||||||||
The input fields of input objects with the same name must be mergeable. This | ||||||||||
rule ensures that input objects with the same name in different source schemas | ||||||||||
have fields that can be merged consistently without conflicts. | ||||||||||
|
||||||||||
Input fields are considered mergeable when they share the same name and have | ||||||||||
compatible types. The compatibility of types is determined by their structure | ||||||||||
(e.g., lists), excluding nullability. Mergeable input fields with different | ||||||||||
nullability are considered mergeable, and the resulting merged field will be the | ||||||||||
most permissive of the two. | ||||||||||
|
||||||||||
In this example, the field `field` in `Input1` has compatible types across | ||||||||||
source schemas, making them mergeable: | ||||||||||
|
||||||||||
```graphql example | ||||||||||
input Input1 { | ||||||||||
field: String! | ||||||||||
} | ||||||||||
|
||||||||||
input Input1 { | ||||||||||
field: String | ||||||||||
} | ||||||||||
``` | ||||||||||
|
||||||||||
The following example shows that fields are mergeable if they have different | ||||||||||
nullability but the named type is the same and the list structure is the same. | ||||||||||
|
||||||||||
```graphql example | ||||||||||
input Input1 { | ||||||||||
tags: [String!] | ||||||||||
} | ||||||||||
|
||||||||||
input Input1 { | ||||||||||
tags: [String]! | ||||||||||
} | ||||||||||
|
||||||||||
input Input1 { | ||||||||||
tags: [String] | ||||||||||
} | ||||||||||
``` | ||||||||||
|
||||||||||
In this example, the field `field` on `Input1` is not mergable as the field has | ||||||||||
different named types across (`String` and `DateTime`) source schemas: | ||||||||||
Comment on lines
+80
to
+81
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
|
||||||||||
|
||||||||||
```graphql counter-example | ||||||||||
input Input1 { | ||||||||||
field: String! | ||||||||||
} | ||||||||||
|
||||||||||
input Input1 { | ||||||||||
field: DateTime! | ||||||||||
} | ||||||||||
``` | ||||||||||
|
||||||||||
### 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.
this is wrong