[typescript-resolvers][federation] Fix federation @requires type

.changeset/small-fans-cross.md

@@ -0,0 +1,7 @@
+---
+'@graphql-codegen/visitor-plugin-common': patch
+'@graphql-codegen/typescript-resolvers': patch
+'@graphql-codegen/plugin-helpers': patch
+---
+
+Update @requires type

dev-test/test-schema/resolvers-federation.ts

@@ -133,6 +133,15 @@ export type FederationTypes = {
   User: User;
 };
 
+/** Mapping of federation reference types */
+export type FederationReferenceTypes = {
+  User: { __typename: 'User' } & (
+    | GraphQLRecursivePick<FederationTypes['User'], { id: true }>
+    | GraphQLRecursivePick<FederationTypes['User'], { name: true }>
+  ) &
+    ({} | GraphQLRecursivePick<FederationTypes['User'], { address: { city: true; lines: { line2: true } } }>);
+};
+
 /** Mapping between all available schema types and the resolvers types */
 export type ResolversTypes = {
   Address: ResolverTypeWrapper<Address>;
@@ -154,13 +163,7 @@ export type ResolversParentTypes = {
   ID: Scalars['ID']['output'];
   Lines: Lines;
   Query: {};
-  User:
-    | User
-    | ({ __typename: 'User' } & (
-        | GraphQLRecursivePick<FederationTypes['User'], { id: true }>
-        | GraphQLRecursivePick<FederationTypes['User'], { name: true }>
-      ) &
-        GraphQLRecursivePick<FederationTypes['User'], { address: { city: true; lines: { line2: true } } }>);
+  User: User | FederationReferenceTypes['User'];
   Int: Scalars['Int']['output'];
   Boolean: Scalars['Boolean']['output'];
 };
@@ -199,15 +202,11 @@ export type QueryResolvers<
 export type UserResolvers<
   ContextType = any,
   ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User'],
-  FederationType extends FederationTypes['User'] = FederationTypes['User']
+  FederationReferenceType extends FederationReferenceTypes['User'] = FederationReferenceTypes['User']
 > = {
   __resolveReference?: ReferenceResolver<
-    Maybe<ResolversTypes['User']>,
-    { __typename: 'User' } & (
-      | GraphQLRecursivePick<FederationType, { id: true }>
-      | GraphQLRecursivePick<FederationType, { name: true }>
-    ) &
-      GraphQLRecursivePick<FederationType, { address: { city: true; lines: { line2: true } } }>,
+    Maybe<ResolversTypes['User']> | FederationReferenceType,
+    FederationReferenceType,
     ContextType
   >;
   email?: Resolver<ResolversTypes['String'], ParentType, ContextType>;

packages/plugins/other/visitor-plugin-common/src/base-resolvers-visitor.ts

@@ -818,12 +818,8 @@ export class BaseResolversVisitor<
       shouldInclude: namedType => !isEnumType(namedType),
       onNotMappedObjectType: ({ typeName, initialType }) => {
         let result = initialType;
-        const federationReferenceTypes = this._federation.printReferenceSelectionSets({
-          typeName,
-          baseFederationType: `${this.convertName('FederationTypes')}['${typeName}']`,
-        });
-        if (federationReferenceTypes) {
-          result += ` | ${federationReferenceTypes}`;
+        if (this._federation.getMeta()[typeName]?.referenceSelectionSetsString) {
+          result += ` | ${this.convertName('FederationReferenceTypes')}['${typeName}']`;
         }
         return result;
       },
@@ -1306,6 +1302,33 @@ export class BaseResolversVisitor<
       ).string;
   }
 
+  public buildFederationReferenceTypes(): string {
+    const federationMeta = this._federation.getMeta();
+
+    if (Object.keys(federationMeta).length === 0) {
+      return '';
+    }
+
+    const declarationKind = 'type';
+    return new DeclarationBlock(this._declarationBlockConfig)
+      .export()
+      .asKind(declarationKind)
+      .withName(this.convertName('FederationReferenceTypes'))
+      .withComment('Mapping of federation reference types')
+      .withBlock(
+        Object.entries(federationMeta)
+          .map(([typeName, { referenceSelectionSetsString }]) => {
+            if (!referenceSelectionSetsString) {
+              return undefined;
+            }
+
+            return indent(`${typeName}: ${referenceSelectionSetsString}${this.getPunctuation(declarationKind)}`);
+          })
+          .filter(v => v)
+          .join('\n')
+      ).string;
+  }
+
   public get schema(): GraphQLSchema {
     return this._schema;
   }
@@ -1586,13 +1609,6 @@ export class BaseResolversVisitor<
           }
         }
 
-        const parentTypeSignature = this._federation.transformFieldParentType({
-          fieldNode: original,
-          parentType,
-          parentTypeSignature: this.getParentTypeForSignature(node),
-          federationTypeSignature: 'FederationType',
-        });
-
         const { mappedTypeKey, resolverType } = ((): { mappedTypeKey: string; resolverType: string } => {
           const baseType = getBaseTypeNode(original.type);
           const realType = baseType.name.value;
@@ -1637,15 +1653,18 @@ export class BaseResolversVisitor<
           name: typeName,
           modifier: avoidResolverOptionals ? '' : '?',
           type: resolverType,
-          genericTypes: [mappedTypeKey, parentTypeSignature, contextType, argsType].filter(f => f),
+          genericTypes: [mappedTypeKey, this.getParentTypeForSignature(node), contextType, argsType].filter(f => f),
         };
 
         if (this._federation.isResolveReferenceField(node)) {
           if (!this._federation.getMeta()[parentType.name].hasResolveReference) {
             return { value: '', meta };
           }
+          const resultType = `${mappedTypeKey} | FederationReferenceType`;
+          const referenceType = 'FederationReferenceType';
+
           signature.type = 'ReferenceResolver';
-          signature.genericTypes = [mappedTypeKey, parentTypeSignature, contextType];
+          signature.genericTypes = [resultType, referenceType, contextType];
           meta.federation = { isResolveReference: true };
         }
 
@@ -1788,7 +1807,7 @@ export class BaseResolversVisitor<
     ];
     this._federation.addFederationTypeGenericIfApplicable({
       genericTypes,
-      federationTypesType: this.convertName('FederationTypes'),
+      federationTypesType: this.convertName('FederationReferenceTypes'),
       typeName,
     });
 
@@ -1975,7 +1994,7 @@ export class BaseResolversVisitor<
     ];
     this._federation.addFederationTypeGenericIfApplicable({
       genericTypes,
-      federationTypesType: this.convertName('FederationTypes'),
+      federationTypesType: this.convertName('FederationReferenceTypes'),
       typeName,
     });
 

packages/plugins/typescript/resolvers/src/index.ts

@@ -250,6 +250,7 @@ export type DirectiveResolverFn<TResult = {}, TParent = {}, TContext = {}, TArgs
 `;
 
   const federationTypes = visitor.buildFederationTypes();
+  const federationReferenceTypes = visitor.buildFederationReferenceTypes();
   const resolversTypeMapping = visitor.buildResolversTypes();
   const resolversParentTypeMapping = visitor.buildResolversParentTypes();
   const resolversUnionTypesMapping = visitor.buildResolversUnionTypes();
@@ -294,6 +295,7 @@ export type DirectiveResolverFn<TResult = {}, TParent = {}, TContext = {}, TArgs
     content: [
       header,
       federationTypes,
+      federationReferenceTypes,
       resolversUnionTypesMapping,
       resolversInterfaceTypesMapping,
       resolversTypeMapping,

packages/plugins/typescript/resolvers/tests/__snapshots__/ts-resolvers.spec.ts.snap

@@ -167,6 +167,7 @@ export type DirectiveResolverFn<TResult = {}, TParent = {}, TContext = {}, TArgs
 ) => TResult | Promise<TResult>;
 
 
+
 /** Mapping of union types */
 export type ResolversUnionTypes<_RefType extends Record<string, unknown>> = ResolversObject<{
   ChildUnion:
@@ -433,6 +434,7 @@ export type DirectiveResolverFn<TResult = {}, TParent = {}, TContext = {}, TArgs
 ) => TResult | Promise<TResult>;
 
 
+
 /** Mapping of union types */
 export type ResolversUnionTypes<_RefType extends Record<string, unknown>> = ResolversObject<{
   ChildUnion:
@@ -785,6 +787,7 @@ export type DirectiveResolverFn<TResult = {}, TParent = {}, TContext = {}, TArgs
 ) => TResult | Promise<TResult>;
 
 
+
 /** Mapping of union types */
 export type ResolversUnionTypes<_RefType extends Record<string, unknown>> = ResolversObject<{
   ChildUnion:

packages/plugins/typescript/resolvers/tests/ts-resolvers.federation.interface.spec.ts

@@ -124,6 +124,19 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - Interface', () => {
         Admin: Admin;
       };
 
+      /** Mapping of federation reference types */
+      export type FederationReferenceTypes = {
+        Person:
+          ( { __typename: 'Person' }
+          & GraphQLRecursivePick<FederationTypes['Person'], {"id":true}> );
+        User:
+          ( { __typename: 'User' }
+          & GraphQLRecursivePick<FederationTypes['User'], {"id":true}> );
+        Admin:
+          ( { __typename: 'Admin' }
+          & GraphQLRecursivePick<FederationTypes['Admin'], {"id":true}> );
+      };
+
 
       /** Mapping of interface types */
       export type ResolversInterfaceTypes<_RefType extends Record<string, unknown>> = {
@@ -150,12 +163,8 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - Interface', () => {
         Query: {};
         Person: ResolversInterfaceTypes<ResolversParentTypes>['Person'];
         ID: Scalars['ID']['output'];
-        User: User |
-          ( { __typename: 'User' }
-          & GraphQLRecursivePick<FederationTypes['User'], {"id":true}> );
-        Admin: Admin |
-          ( { __typename: 'Admin' }
-          & GraphQLRecursivePick<FederationTypes['Admin'], {"id":true}> );
+        User: User | FederationReferenceTypes['User'];
+        Admin: Admin | FederationReferenceTypes['Admin'];
         Boolean: Scalars['Boolean']['output'];
         PersonName: PersonName;
         String: Scalars['String']['output'];
@@ -165,26 +174,20 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - Interface', () => {
         me?: Resolver<Maybe<ResolversTypes['Person']>, ParentType, ContextType>;
       };
 
-      export type PersonResolvers<ContextType = any, ParentType extends ResolversParentTypes['Person'] = ResolversParentTypes['Person'], FederationType extends FederationTypes['Person'] = FederationTypes['Person']> = {
+      export type PersonResolvers<ContextType = any, ParentType extends ResolversParentTypes['Person'] = ResolversParentTypes['Person'], FederationReferenceType extends FederationReferenceTypes['Person'] = FederationReferenceTypes['Person']> = {
         __resolveType: TypeResolveFn<'User' | 'Admin', ParentType, ContextType>;
-        __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['Person']>,
-          ( { __typename: 'Person' }
-          & GraphQLRecursivePick<FederationType, {"id":true}> ), ContextType>;
+        __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['Person']> | FederationReferenceType, FederationReferenceType, ContextType>;
       };
 
-      export type UserResolvers<ContextType = any, ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User'], FederationType extends FederationTypes['User'] = FederationTypes['User']> = {
-        __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']>,
-          ( { __typename: 'User' }
-          & GraphQLRecursivePick<FederationType, {"id":true}> ), ContextType>;
+      export type UserResolvers<ContextType = any, ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User'], FederationReferenceType extends FederationReferenceTypes['User'] = FederationReferenceTypes['User']> = {
+        __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']> | FederationReferenceType, FederationReferenceType, ContextType>;
         id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
         name?: Resolver<ResolversTypes['PersonName'], ParentType, ContextType>;
         __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
       };
 
-      export type AdminResolvers<ContextType = any, ParentType extends ResolversParentTypes['Admin'] = ResolversParentTypes['Admin'], FederationType extends FederationTypes['Admin'] = FederationTypes['Admin']> = {
-        __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['Admin']>,
-          ( { __typename: 'Admin' }
-          & GraphQLRecursivePick<FederationType, {"id":true}> ), ContextType>;
+      export type AdminResolvers<ContextType = any, ParentType extends ResolversParentTypes['Admin'] = ResolversParentTypes['Admin'], FederationReferenceType extends FederationReferenceTypes['Admin'] = FederationReferenceTypes['Admin']> = {
+        __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['Admin']> | FederationReferenceType, FederationReferenceType, ContextType>;
         id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
         name?: Resolver<ResolversTypes['PersonName'], ParentType, ContextType>;
         canImpersonate?: Resolver<ResolversTypes['Boolean'], ParentType, ContextType>;

packages/plugins/typescript/resolvers/tests/ts-resolvers.federation.mappers.spec.ts

@@ -17,6 +17,12 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - mappers', () => {
         id: ID!
         user: User!
       }
+
+      type Account @key(fields: "id") {
+        id: ID!
+        name: String! @external
+        displayName: String! @requires(fields: "name")
+      }
     `;
 
     const content = await generate({
@@ -25,14 +31,15 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - mappers', () => {
         federation: true,
         mappers: {
           User: './mappers#UserMapper',
+          Account: './mappers#AccountMapper',
         },
       },
     });
 
     // User should have it
     expect(content).toMatchInlineSnapshot(`
       "import { GraphQLResolveInfo } from 'graphql';
-      import { UserMapper } from './mappers';
+      import { UserMapper, AccountMapper } from './mappers';
       export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
 
 
@@ -115,6 +122,19 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - mappers', () => {
       /** Mapping of federation types */
       export type FederationTypes = {
         User: User;
+        Account: Account;
+      };
+
+      /** Mapping of federation reference types */
+      export type FederationReferenceTypes = {
+        User:
+          ( { __typename: 'User' }
+          & GraphQLRecursivePick<FederationTypes['User'], {"id":true}> );
+        Account:
+          ( { __typename: 'Account' }
+          & GraphQLRecursivePick<FederationTypes['Account'], {"id":true}>
+          & ( {}
+              | GraphQLRecursivePick<FederationTypes['Account'], {"name":true}> ) );
       };
 
 
@@ -126,6 +146,7 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - mappers', () => {
         ID: ResolverTypeWrapper<Scalars['ID']['output']>;
         String: ResolverTypeWrapper<Scalars['String']['output']>;
         UserProfile: ResolverTypeWrapper<Omit<UserProfile, 'user'> & { user: ResolversTypes['User'] }>;
+        Account: ResolverTypeWrapper<AccountMapper>;
         Boolean: ResolverTypeWrapper<Scalars['Boolean']['output']>;
       };
 
@@ -136,17 +157,16 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - mappers', () => {
         ID: Scalars['ID']['output'];
         String: Scalars['String']['output'];
         UserProfile: Omit<UserProfile, 'user'> & { user: ResolversParentTypes['User'] };
+        Account: AccountMapper;
         Boolean: Scalars['Boolean']['output'];
       };
 
       export type QueryResolvers<ContextType = any, ParentType extends ResolversParentTypes['Query'] = ResolversParentTypes['Query']> = {
         me?: Resolver<Maybe<ResolversTypes['User']>, ParentType, ContextType>;
       };
 
-      export type UserResolvers<ContextType = any, ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User'], FederationType extends FederationTypes['User'] = FederationTypes['User']> = {
-        __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']>,
-          ( { __typename: 'User' }
-          & GraphQLRecursivePick<FederationType, {"id":true}> ), ContextType>;
+      export type UserResolvers<ContextType = any, ParentType extends ResolversParentTypes['User'] = ResolversParentTypes['User'], FederationReferenceType extends FederationReferenceTypes['User'] = FederationReferenceTypes['User']> = {
+        __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']> | FederationReferenceType, FederationReferenceType, ContextType>;
         id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
         name?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
       };
@@ -156,10 +176,17 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - mappers', () => {
         user?: Resolver<ResolversTypes['User'], ParentType, ContextType>;
       };
 
+      export type AccountResolvers<ContextType = any, ParentType extends ResolversParentTypes['Account'] = ResolversParentTypes['Account'], FederationReferenceType extends FederationReferenceTypes['Account'] = FederationReferenceTypes['Account']> = {
+        __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['Account']> | FederationReferenceType, FederationReferenceType, ContextType>;
+        id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
+        displayName?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+      };
+
       export type Resolvers<ContextType = any> = {
         Query?: QueryResolvers<ContextType>;
         User?: UserResolvers<ContextType>;
         UserProfile?: UserProfileResolvers<ContextType>;
+        Account?: AccountResolvers<ContextType>;
       };
 
       "