[resolvers][federation] Add __resolveReference to applicable Interface entities, fix Interface types having non-meta resolver fields
#10221
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| --- | ||
| '@graphql-codegen/visitor-plugin-common': major | ||
| '@graphql-codegen/typescript-resolvers': major | ||
| '@graphql-codegen/plugin-helpers': major | ||
| --- | ||
|
|
||
| Ensure Federation Interfaces have `__resolveReference` if they are resolvable entities | ||
|
|
||
| BREAKING CHANGES: Deprecate `onlyResolveTypeForInterfaces` because majority of use cases cannot implement resolvers in Interfaces. | ||
| BREAKING CHANGES: Deprecate `generateInternalResolversIfNeeded.__resolveReference` because types do not have `__resolveReference` if they are not Federation entities or are not resolvable. Users should not have to manually set this option. This option was put in to wait for this major version. |
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 |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| import { ApolloFederation, type FederationMeta, getBaseType } from '@graphql-codegen/plugin-helpers'; | ||
| import { getRootTypeNames } from '@graphql-tools/utils'; | ||
| import autoBind from 'auto-bind'; | ||
| import { | ||
|
|
@@ -78,13 +78,15 @@ export interface ParsedResolversConfig extends ParsedConfig { | |
| allResolversTypeName: string; | ||
| internalResolversPrefix: string; | ||
| generateInternalResolversIfNeeded: NormalizedGenerateInternalResolversIfNeededConfig; | ||
| directiveResolverMappings: Record<string, string>; | ||
| resolversNonOptionalTypename: ResolversNonOptionalTypenameConfig; | ||
| avoidCheckingAbstractTypesRecursively: boolean; | ||
| } | ||
|
|
||
| type FieldDefinitionPrintFn = ( | ||
| parentName: string, | ||
| avoidResolverOptionals: boolean | ||
| ) => { value: string | null; meta: { federation?: { isResolveReference: boolean } } }; | ||
| export interface RootResolver { | ||
| content: string; | ||
| generatedResolverTypes: { | ||
|
|
@@ -584,20 +586,13 @@ export interface RawResolversConfig extends RawConfig { | |
| internalResolversPrefix?: string; | ||
| /** | ||
| * @type object | ||
| * @default {} | ||
| * @description If relevant internal resolvers are set to `true`, the resolver type will only be generated if the right conditions are met. | ||
| * Enabling this allows a more correct type generation for the resolvers. | ||
| * For example: | ||
| * - `__isTypeOf` is generated for implementing types and union members | ||
| */ | ||
| generateInternalResolversIfNeeded?: GenerateInternalResolversIfNeededConfig; | ||
|
There was a problem hiding this comment.
|
||
|
Comment on lines
-595
to
-600
There was a problem hiding this comment. Related #5648
I think it's simpler just to deprecate this option as we are moving to a new major version. If anyone needs it, we can put it back as a minor version |
||
| /** | ||
| * @description Makes `__typename` of resolver mappings non-optional without affecting the base types. | ||
| * @default false | ||
|
|
@@ -700,7 +695,8 @@ export class BaseResolversVisitor< | |
| rawConfig: TRawConfig, | ||
| additionalConfig: TPluginConfig, | ||
| private _schema: GraphQLSchema, | ||
| defaultScalars: NormalizedScalarsMap = DEFAULT_SCALARS, | ||
| federationMeta: FederationMeta = {} | ||
| ) { | ||
| super(rawConfig, { | ||
| immutableTypes: getConfigValue(rawConfig.immutableTypes, false), | ||
|
|
@@ -714,7 +710,6 @@ export class BaseResolversVisitor< | |
| mapOrStr: rawConfig.enumValues, | ||
| }), | ||
| addUnderscoreToArgsType: getConfigValue(rawConfig.addUnderscoreToArgsType, false), | ||
| contextType: parseMapper(rawConfig.contextType || 'any', 'ContextType'), | ||
| fieldContextTypes: getConfigValue(rawConfig.fieldContextTypes, []), | ||
| directiveContextTypes: getConfigValue(rawConfig.directiveContextTypes, []), | ||
|
|
@@ -729,9 +724,7 @@ export class BaseResolversVisitor< | |
| mappers: transformMappers(rawConfig.mappers || {}, rawConfig.mapperTypeSuffix), | ||
| scalars: buildScalarsFromConfig(_schema, rawConfig, defaultScalars), | ||
| internalResolversPrefix: getConfigValue(rawConfig.internalResolversPrefix, '__'), | ||
| generateInternalResolversIfNeeded: {}, | ||
| resolversNonOptionalTypename: normalizeResolversNonOptionalTypename( | ||
| getConfigValue(rawConfig.resolversNonOptionalTypename, false) | ||
| ), | ||
|
|
@@ -740,7 +733,11 @@ export class BaseResolversVisitor< | |
| } as TPluginConfig); | ||
|
|
||
| autoBind(this); | ||
| this._federation = new ApolloFederation({ | ||
| enabled: this.config.federation, | ||
| schema: this.schema, | ||
| meta: federationMeta, | ||
| }); | ||
| this._rootTypeNames = getRootTypeNames(_schema); | ||
| this._variablesTransformer = new OperationVariablesToObject( | ||
| this.scalars, | ||
|
|
@@ -1358,7 +1355,9 @@ export class BaseResolversVisitor< | |
|
|
||
| const federationMeta = this._federation.getMeta()[schemaTypeName]; | ||
| if (federationMeta) { | ||
| userDefinedTypes[schemaTypeName].federation = { | ||
| hasResolveReference: federationMeta.hasResolveReference, | ||
| }; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -1474,9 +1473,10 @@ export class BaseResolversVisitor< | |
| const baseType = getBaseTypeNode(original.type); | ||
| const realType = baseType.name.value; | ||
| const parentType = this.schema.getType(parentName); | ||
| const meta: ReturnType<FieldDefinitionPrintFn>['meta'] = {}; | ||
|
|
||
| if (this._federation.skipField({ fieldNode: original, parentType })) { | ||
| return { value: null, meta }; | ||
| } | ||
|
|
||
| const contextType = this.getContextType(parentName, node); | ||
|
|
@@ -1516,7 +1516,7 @@ export class BaseResolversVisitor< | |
| } | ||
| } | ||
|
|
||
| const parentTypeSignature = this._federation.transformFieldParentType({ | ||
| fieldNode: original, | ||
| parentType, | ||
| parentTypeSignature: this.getParentTypeForSignature(node), | ||
|
|
@@ -1545,29 +1545,22 @@ export class BaseResolversVisitor< | |
| }; | ||
|
|
||
| if (this._federation.isResolveReferenceField(node)) { | ||
| if (!this._federation.getMeta()[parentType.name].hasResolveReference) { | ||
| return { value: '', meta }; | ||
| } | ||
| signature.type = 'ReferenceResolver'; | ||
|
Comment on lines
-1561
to
-1563
There was a problem hiding this comment. It's a bit odd to run |
||
| signature.genericTypes = [mappedTypeKey, parentTypeSignature, contextType]; | ||
| meta.federation = { isResolveReference: true }; | ||
| } | ||
|
|
||
| return { | ||
| value: indent( | ||
| `${signature.name}${signature.modifier}: ${signature.type}<${signature.genericTypes.join( | ||
| ', ' | ||
| )}>${this.getPunctuation(declarationKind)}` | ||
| ), | ||
| meta, | ||
| }; | ||
| }; | ||
| } | ||
|
|
||
|
|
@@ -1628,7 +1621,7 @@ export class BaseResolversVisitor< | |
| (rootType === 'mutation' && this.config.avoidOptionals.mutation) || | ||
| (rootType === 'subscription' && this.config.avoidOptionals.subscription) || | ||
| (rootType === false && this.config.avoidOptionals.resolvers) | ||
| ).value; | ||
| }); | ||
|
|
||
| if (!rootType) { | ||
|
|
@@ -1645,10 +1638,11 @@ export class BaseResolversVisitor< | |
| `ContextType = ${this.config.contextType.type}`, | ||
| this.transformParentGenericType(parentType), | ||
| ]; | ||
| this._federation.addFederationTypeGenericIfApplicable({ | ||
| genericTypes, | ||
| federationTypesType: this.convertName('FederationTypes'), | ||
| typeName, | ||
| }); | ||
|
|
||
| const block = new DeclarationBlock(this._declarationBlockConfig) | ||
| .export() | ||
|
|
@@ -1837,25 +1831,44 @@ export class BaseResolversVisitor< | |
| } | ||
|
|
||
| const parentType = this.getParentTypeToUse(typeName); | ||
|
|
||
| const genericTypes: string[] = [ | ||
| `ContextType = ${this.config.contextType.type}`, | ||
| this.transformParentGenericType(parentType), | ||
| ]; | ||
| this._federation.addFederationTypeGenericIfApplicable({ | ||
| genericTypes, | ||
| federationTypesType: this.convertName('FederationTypes'), | ||
| typeName, | ||
| }); | ||
|
|
||
| const possibleTypes = implementingTypes.map(name => `'${name}'`).join(' | ') || 'null'; | ||
|
|
||
| // An Interface has __resolveType resolver, and no other fields. | ||
| const blockFields: string[] = [ | ||
| indent( | ||
| `${this.config.internalResolversPrefix}resolveType${ | ||
| this.config.optionalResolveType ? '?' : '' | ||
| }: TypeResolveFn<${possibleTypes}, ParentType, ContextType>${this.getPunctuation(declarationKind)}` | ||
| ), | ||
| ]; | ||
|
|
||
| // An Interface in Federation may have the additional __resolveReference resolver, if resolvable. | ||
| // So, we filter out the normal fields declared on the Interface and add the __resolveReference resolver. | ||
| const fields = (node.fields as unknown as FieldDefinitionPrintFn[]).map(f => | ||
| f(typeName, this.config.avoidOptionals.resolvers) | ||
| ); | ||
| for (const field of fields) { | ||
| if (field.meta.federation?.isResolveReference) { | ||
| blockFields.push(field.value); | ||
| } | ||
| } | ||
|
|
||
| return new DeclarationBlock(this._declarationBlockConfig) | ||
| .export() | ||
| .asKind(declarationKind) | ||
| .withName(name, `<${genericTypes.join(', ')}>`) | ||
| .withBlock(blockFields.join('\n')).string; | ||
| } | ||
|
|
||
| SchemaDefinition() { | ||
|
|
||
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
Oops, something went wrong.
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.
Unfortunately, we don't know if a field is
__resolveReferenceor not until we have generated it. This is because we are injecting__resolveReferenceas real fields inaddFederationReferencesToSchema. Therefore, we need to addmetato have more info about the generated field