Don't automatically add key fields to union selections #5562
Conversation
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
✅ Deploy Preview for apollo-android-docs canceled.
|
Comment on lines
90
to
95
| val requiredFieldNames = if (schema.typeDefinition(parentType) is GQLUnionTypeDefinition) { | ||
| // Can't select any fields on unions other than __typename | ||
| mutableSetOf() | ||
| } else { | ||
| schema.keyFields(parentType).toMutableSet() | ||
| } |
There was a problem hiding this comment.
Should we allow @typePolicy on unions in the first place?
# This feels out of place. SomeUnion has no `id` field.
extend union SomeUnion @typePolicy(keyFields: "id") There was a problem hiding this comment.
Yeah I was wondering about this :) We could forbid it too, it might be less confusing.
There was a problem hiding this comment.
For the record, we talked about this and decided to keep the directive definition untouched but add validation that the keyFields actually exists, which should make an error here.
There was a problem hiding this comment.
Turns out this validation already existed but wasn't performed on interfaces nor unions.
…tion for embeddedFields and connectionFields
BoD
force-pushed
the
fix-typepolicy-keyfields-on-union
branch
from
65ab702
to
c636040
Compare
martinbonnin
requested changes
Jan 25, 2024
Comment on lines
+449
to
+458
| i.directives.forEach { directive -> | ||
| validateDirective(directive, i) { | ||
| issues.add(it.constContextError()) | ||
| } | ||
| } | ||
|
|
||
| i.fields.forEach { gqlFieldDefinition -> | ||
| gqlFieldDefinition.directives.forEach { gqlDirective -> | ||
| validateDirective(gqlDirective, gqlFieldDefinition) { | ||
| issues.add(it.constContextError()) |
There was a problem hiding this comment.
FWIW, this is where having a visitor pattern for validation would be useful. Maybe not right now but at some point.
Comment on lines
239
to
282
| val keyFieldsArg = directive.arguments.firstOrNull { it.name == "keyFields" } | ||
| if (keyFieldsArg != null) { | ||
| (keyFieldsArg.value as GQLStringValue).value.parseAsGQLSelections().getOrThrow().forEach { selection -> | ||
| if (selection !is GQLField) { | ||
| registerIssue("Fragments are not supported in @$TYPE_POLICY directives", keyFieldsArg.sourceLocation) | ||
| } else if (selection.selections.isNotEmpty()) { | ||
| registerIssue("Composite fields are not supported in @$TYPE_POLICY directives", keyFieldsArg.sourceLocation) | ||
| } else { | ||
| val definition = fieldDefinitions.firstOrNull { it.name == selection.name } | ||
| if (definition == null) { | ||
| registerIssue("Field '${selection.name}' is not a valid key field for type '$type'", keyFieldsArg.sourceLocation) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| val embeddedFieldsArg = directive.arguments.firstOrNull { it.name == "embeddedFields" } | ||
| if (embeddedFieldsArg != null) { | ||
| (embeddedFieldsArg.value as GQLStringValue).value.parseAsGQLSelections().getOrThrow().forEach { selection -> | ||
| if (selection !is GQLField) { | ||
| registerIssue("Fragments are not supported in @$TYPE_POLICY directives", embeddedFieldsArg.sourceLocation) | ||
| } else if (selection.selections.isNotEmpty()) { | ||
| registerIssue("Composite fields are not supported in @$TYPE_POLICY directives", embeddedFieldsArg.sourceLocation) | ||
| } else { | ||
| val definition = fieldDefinitions.firstOrNull { it.name == selection.name } | ||
| if (definition == null) { | ||
| registerIssue("Field '${selection.name}' is not a valid embedded field for type '$type'", embeddedFieldsArg.sourceLocation) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| val connectionFieldsArg = directive.arguments.firstOrNull { it.name == "connectionFields" } | ||
| if (connectionFieldsArg != null) { | ||
| (connectionFieldsArg.value as GQLStringValue).value.parseAsGQLSelections().getOrThrow().forEach { selection -> | ||
| if (selection !is GQLField) { | ||
| registerIssue("Fragments are not supported in @$TYPE_POLICY directives", connectionFieldsArg.sourceLocation) | ||
| } else if (selection.selections.isNotEmpty()) { | ||
| registerIssue("Composite fields are not supported in @$TYPE_POLICY directives", connectionFieldsArg.sourceLocation) | ||
| } else { | ||
| val definition = fieldDefinitions.firstOrNull { it.name == selection.name } | ||
| if (definition == null) { | ||
| registerIssue("Field '${selection.name}' is not a valid connection field for type '$type'", connectionFieldsArg.sourceLocation) | ||
| } |
There was a problem hiding this comment.
👍
Also, can this logic be factored in? Looks like it's very similar?
Comment on lines
119
to
121
| check(issues.any { it.message.contains("Field 'id' is not a valid key field for type 'Animal'") }) | ||
| check(issues.any { it.message.contains("Field 'version' is not a valid key field for type 'Node'") }) | ||
| check(issues.any { it.message.contains("Field 'x' is not a valid key field for type 'Foo'") }) |
There was a problem hiding this comment.
Nit: I'd change the error to something like
"No such field: 'Foo.x'"
I think there's no need to mention "key" since it's easy to see from the context and sourceLocation.
martinbonnin
approved these changes
Jan 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Key fields were added to selections of unions, but that's not valid as unions have no fields (except
__typename), and was crashing later on here.We can still check if selections have the key fields at least.