Allow interface resolveType functions to resolve to child interfaces #3599
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 |
|---|---|---|
|
|
@@ -271,7 +271,7 @@ describe('Execute: Handles execution of abstract types', () => { | |
| errors: [ | ||
| { | ||
| message: | ||
| 'Abstract type "Pet" must resolve to an Object type or an intermediate Interface type at runtime for field "Query.pet". Either the "Pet" type should provide a "resolveType" function or each possible type should provide an "isTypeOf" function.', | ||
| locations: [{ line: 3, column: 9 }], | ||
| path: ['pet'], | ||
| }, | ||
|
|
@@ -610,15 +610,15 @@ describe('Execute: Handles execution of abstract types', () => { | |
| } | ||
|
|
||
| expectError({ forTypeName: undefined }).toEqual( | ||
| 'Abstract type "Pet" must resolve to an Object type or an intermediate Interface type at runtime for field "Query.pet". Either the "Pet" type should provide a "resolveType" function or each possible type should provide an "isTypeOf" function.', | ||
| ); | ||
|
|
||
| expectError({ forTypeName: 'Human' }).toEqual( | ||
| 'Abstract type "Pet" was resolved to a type "Human" that does not exist inside the schema.', | ||
| ); | ||
|
|
||
| expectError({ forTypeName: 'String' }).toEqual( | ||
| 'Abstract type "Pet" was resolved to a non-object and non-interface type "String".', | ||
| ); | ||
|
|
||
| expectError({ forTypeName: '__Schema' }).toEqual( | ||
|
|
@@ -629,7 +629,7 @@ describe('Execute: Handles execution of abstract types', () => { | |
| // @ts-expect-error | ||
| assertInterfaceType(schema.getType('Pet')).resolveType = () => []; | ||
| expectError({ forTypeName: undefined }).toEqual( | ||
| 'Abstract type "Pet" must resolve to an Object type or an intermediate Interface type at runtime for field "Query.pet" with value { __typename: undefined }, received "[]".', | ||
| ); | ||
|
|
||
| // FIXME: workaround since we can't inject resolveType into SDL | ||
|
|
@@ -640,4 +640,119 @@ describe('Execute: Handles execution of abstract types', () => { | |
| 'Support for returning GraphQLObjectType from resolveType was removed in [email protected] please return type name instead.', | ||
| ); | ||
| }); | ||
|
|
||
| it('hierarchical resolveType with Interfaces yields useful error', () => { | ||
| const schema = buildSchema(` | ||
| type Query { | ||
| named: Named | ||
| } | ||
|
|
||
| interface Named { | ||
| name: String | ||
| } | ||
|
|
||
| interface Animal { | ||
| isFriendly: Boolean | ||
| } | ||
|
|
||
| interface Pet implements Named & Animal { | ||
| name: String | ||
| isFriendly: Boolean | ||
| } | ||
|
|
||
| type Cat implements Pet & Named & Animal { | ||
| name: String | ||
| isFriendly: Boolean | ||
| } | ||
|
|
||
| type Dog implements Pet & Named & Animal { | ||
| name: String | ||
| isFriendly: Boolean | ||
| } | ||
|
|
||
| type Person implements Named { | ||
| name: String | ||
| } | ||
| `); | ||
|
|
||
| const document = parse(` | ||
| { | ||
| named { | ||
| name | ||
| } | ||
| } | ||
| `); | ||
|
|
||
| function expectError() { | ||
| const rootValue = { named: {} }; | ||
| const result = executeSync({ schema, document, rootValue }); | ||
| return { | ||
| toEqual(message: string) { | ||
| expectJSON(result).toDeepEqual({ | ||
| data: { named: null }, | ||
| errors: [ | ||
| { | ||
| message, | ||
| locations: [{ line: 3, column: 9 }], | ||
| path: ['named'], | ||
| }, | ||
| ], | ||
| }); | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| const namedType = assertInterfaceType(schema.getType('Named')); | ||
| // FIXME: workaround since we can't inject resolveType into SDL | ||
| namedType.resolveType = () => 'Animal'; | ||
| expectError().toEqual( | ||
| 'Interface type "Animal" is not a possible type for "Named".', | ||
| ); | ||
|
|
||
| const petType = assertInterfaceType(schema.getType('Pet')); | ||
| // FIXME: workaround since we can't inject resolveType into SDL | ||
| namedType.resolveType = () => 'Pet'; | ||
| petType.resolveType = () => 'Person'; | ||
| expectError().toEqual( | ||
| 'Runtime Object type "Person" is not a possible type for "Pet".', | ||
| ); | ||
|
|
||
| // FIXME: workaround since we can't inject resolveType into SDL | ||
| namedType.resolveType = () => 'Pet'; | ||
| petType.resolveType = () => undefined; | ||
| expectError().toEqual( | ||
| 'Abstract type "Pet" must resolve to an Object type or an intermediate Interface type at runtime for field "Query.named". Either the "Pet" type should provide a "resolveType" function or each possible type should provide an "isTypeOf" function.', | ||
| ); | ||
|
|
||
| // FIXME: workaround since we can't inject resolveType into SDL | ||
| petType.resolveType = () => 'Human'; | ||
| expectError().toEqual( | ||
| 'Abstract type "Pet" was resolved to a type "Human" that does not exist inside the schema.', | ||
| ); | ||
|
|
||
| // FIXME: workaround since we can't inject resolveType into SDL | ||
| petType.resolveType = () => 'String'; | ||
| expectError().toEqual( | ||
| 'Abstract type "Pet" was resolved to a non-object and non-interface type "String".', | ||
| ); | ||
|
|
||
| // FIXME: workaround since we can't inject resolveType into SDL | ||
| petType.resolveType = () => '__Schema'; | ||
| expectError().toEqual( | ||
| 'Runtime Object type "__Schema" is not a possible type for "Pet".', | ||
| ); | ||
|
|
||
| // FIXME: workaround since we can't inject resolveType into SDL | ||
| // @ts-expect-error | ||
| petType.resolveType = () => []; | ||
| expectError().toEqual( | ||
| 'Abstract type "Pet" must resolve to an Object type or an intermediate Interface type at runtime for field "Query.named" with value {}, received "[]".', | ||
| ); | ||
|
|
||
| // FIXME: workaround since we can't inject resolveType into SDL | ||
| petType.resolveType = () => 'Pet'; | ||
| expectError().toEqual( | ||
| 'Interface type "Pet" is not a possible type for "Pet".', | ||
| ); | ||
| }); | ||
| }); | ||
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 |
|---|---|---|
|
|
@@ -39,6 +39,7 @@ import type { | |
| } from '../type/definition'; | ||
| import { | ||
| isAbstractType, | ||
| isInterfaceType, | ||
| isLeafType, | ||
| isListType, | ||
| isNonNullType, | ||
|
|
@@ -790,106 +791,128 @@ function completeLeafValue( | |
| */ | ||
| function completeAbstractValue( | ||
| exeContext: ExecutionContext, | ||
| abstractType: GraphQLAbstractType, | ||
| fieldNodes: ReadonlyArray<FieldNode>, | ||
| info: GraphQLResolveInfo, | ||
| path: Path, | ||
| result: unknown, | ||
| ): PromiseOrValue<ObjMap<unknown>> { | ||
| const resolveTypeFn = abstractType.resolveType ?? exeContext.typeResolver; | ||
| const contextValue = exeContext.contextValue; | ||
| const possibleRuntimeTypeName = resolveTypeFn( | ||
| result, | ||
| contextValue, | ||
| info, | ||
| abstractType, | ||
| ); | ||
|
|
||
| return completeAbstractValueImpl( | ||
| exeContext, | ||
| abstractType, | ||
| possibleRuntimeTypeName, | ||
| fieldNodes, | ||
| info, | ||
| path, | ||
| result, | ||
| ); | ||
| } | ||
|
|
||
| function completeAbstractValueImpl( | ||
| exeContext: ExecutionContext, | ||
| abstractType: GraphQLAbstractType, | ||
| possibleRuntimeTypeName: PromiseOrValue<string | undefined>, | ||
| fieldNodes: ReadonlyArray<FieldNode>, | ||
| info: GraphQLResolveInfo, | ||
| path: Path, | ||
| result: unknown, | ||
| ): PromiseOrValue<ObjMap<unknown>> { | ||
| if (isPromise(possibleRuntimeTypeName)) { | ||
| return possibleRuntimeTypeName.then((resolved) => | ||
| completeAbstractValueImpl( | ||
| exeContext, | ||
| abstractType, | ||
| resolved, | ||
| fieldNodes, | ||
| info, | ||
| path, | ||
| result, | ||
| ), | ||
| ); | ||
| } | ||
|
|
||
| if (possibleRuntimeTypeName == null) { | ||
| throw new GraphQLError( | ||
| `Abstract type "${abstractType.name}" must resolve to an Object type or an intermediate Interface type at runtime for field "${info.parentType.name}.${info.fieldName}". Either the "${abstractType.name}" type should provide a "resolveType" function or each possible type should provide an "isTypeOf" function.`, | ||
| { nodes: fieldNodes }, | ||
| ); | ||
| } | ||
|
|
||
| // releases before 16.0.0 supported returning `GraphQLObjectType` from `resolveType` | ||
| // TODO: remove in 17.0.0 release | ||
| if (isObjectType(possibleRuntimeTypeName)) { | ||
| throw new GraphQLError( | ||
| 'Support for returning GraphQLObjectType from resolveType was removed in [email protected] please return type name instead.', | ||
| ); | ||
| } | ||
|
|
||
| if (typeof possibleRuntimeTypeName !== 'string') { | ||
| throw new GraphQLError( | ||
| `Abstract type "${abstractType.name}" must resolve to an Object type or an intermediate Interface type at runtime for field "${info.parentType.name}.${info.fieldName}" with ` + | ||
| `value ${inspect(result)}, received "${inspect( | ||
| possibleRuntimeTypeName, | ||
| )}".`, | ||
| ); | ||
| } | ||
|
|
||
| const possibleRuntimeType = exeContext.schema.getType( | ||
| possibleRuntimeTypeName, | ||
| ); | ||
| if (possibleRuntimeType == null) { | ||
| throw new GraphQLError( | ||
| `Abstract type "${abstractType.name}" was resolved to a type "${possibleRuntimeTypeName}" that does not exist inside the schema.`, | ||
| { nodes: fieldNodes }, | ||
| ); | ||
| } | ||
|
|
||
| if (isInterfaceType(possibleRuntimeType)) { | ||
|
There was a problem hiding this comment. Nevermind - based on feedback from WG discussion, a union type shouldn't be possible (though does this get potentially complicated by the proposal for union constraints via implementing interfaces? There was a problem hiding this comment. Yes, if unions ever implement interfaces, they could potentially be a link in the chain! |
||
| if (!exeContext.schema.isSubType(abstractType, possibleRuntimeType)) { | ||
| throw new GraphQLError( | ||
| `Interface type "${possibleRuntimeType.name}" is not a possible type for "${abstractType.name}".`, | ||
| { nodes: fieldNodes }, | ||
| ); | ||
| } | ||
|
|
||
| return completeAbstractValue( | ||
| exeContext, | ||
| possibleRuntimeType, | ||
| fieldNodes, | ||
| info, | ||
| path, | ||
| result, | ||
| ); | ||
| } | ||
|
|
||
| if (!isObjectType(possibleRuntimeType)) { | ||
| throw new GraphQLError( | ||
| `Abstract type "${abstractType.name}" was resolved to a non-object and non-interface type "${possibleRuntimeTypeName}".`, | ||
| { nodes: fieldNodes }, | ||
| ); | ||
| } | ||
|
|
||
| if (!exeContext.schema.isSubType(abstractType, possibleRuntimeType)) { | ||
| throw new GraphQLError( | ||
| `Runtime Object type "${possibleRuntimeType.name}" is not a possible type for "${abstractType.name}".`, | ||
| { nodes: fieldNodes }, | ||
| ); | ||
| } | ||
| return completeObjectValue( | ||
| exeContext, | ||
| possibleRuntimeType, | ||
| fieldNodes, | ||
| info, | ||
| path, | ||
| result, | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
|
|
||
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.
What do you think about only altering this error message in the case that an intermediate Interface type actually exists as a potential case?
Looking at the unit test impact, my sense is the primary downside of this change is the additional complication to this error message that makes it slightly harder to understand.
Ideally for the large majority common case where there is no intermediate interface, we don't burden the error message
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.
👍 Tailoring the error message to the interface at hand seems pretty reasonable.