[resolvers] Ensure __isTypeof is only generated for implementing types (of Interfaces) or Union members

.changeset/angry-lamps-notice.md

@@ -0,0 +1,7 @@
+---
+'@graphql-codegen/visitor-plugin-common': major
+'@graphql-codegen/typescript-resolvers': major
+'@graphql-codegen/plugin-helpers': major
+---
+
+BREAKING CHANGES: Do not generate \_\_isTypeOf for non-implementing types or non-union members

dev-test/modules/types.ts

@@ -220,7 +220,6 @@ export type ArticleResolvers<
   id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   text?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   title?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type CreditCardResolvers<
@@ -241,7 +240,6 @@ export type DonationResolvers<
   id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   recipient?: Resolver<ResolversTypes['User'], ParentType, ContextType>;
   sender?: Resolver<ResolversTypes['User'], ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type MutationResolvers<
@@ -298,7 +296,6 @@ export type UserResolvers<
   id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   lastName?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   paymentOptions?: Resolver<Maybe<Array<ResolversTypes['PaymentOption']>>, ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type Resolvers<ContextType = any> = {

dev-test/subpath-import/result.d.ts

@@ -144,7 +144,6 @@ export type UserResolvers<
   name?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   password?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   updatedAt?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type MutationResolvers<
@@ -157,7 +156,6 @@ export type MutationResolvers<
     FiedContextType,
     RequireFields<MutationCreateUserArgs, 'email' | 'name' | 'password'>
   >;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type Resolvers<ContextType = TestContext> = {

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

@@ -166,15 +166,13 @@ export type AddressResolvers<
   city?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   lines?: Resolver<ResolversTypes['Lines'], ParentType, ContextType>;
   state?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type BookResolvers<
   ContextType = any,
   ParentType extends ResolversParentTypes['Book'] = ResolversParentTypes['Book']
 > = {
   id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type LinesResolvers<
@@ -183,7 +181,6 @@ export type LinesResolvers<
 > = {
   line1?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   line2?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type QueryResolvers<
@@ -216,8 +213,6 @@ export type UserResolvers<
       GraphQLRecursivePick<FederationType, { address: { city: true; lines: { line2: true } } }>,
     ContextType
   >;
-
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type Resolvers<ContextType = any> = {

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

@@ -141,7 +141,6 @@ export type QueryResolvers<
   ParentType extends ResolversParentTypes['Query'] = ResolversParentTypes['Query']
 > = {
   someDummyField?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type QueryRootResolvers<
@@ -172,7 +171,6 @@ export type UserResolvers<
   email?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   id?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
   name?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type Resolvers<ContextType = any> = {

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

@@ -162,7 +162,6 @@ export type UserResolvers<
   email?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   id?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
   name?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type Resolvers<ContextType = any> = {

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

@@ -148,7 +148,6 @@ export type UserResolvers<
   email?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   id?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
   name?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type Resolvers<ContextType = any> = {

dev-test/test-schema/typings.ts

@@ -136,7 +136,6 @@ export type UserResolvers<
   email?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   id?: Resolver<ResolversTypes['Int'], ParentType, ContextType>;
   name?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
 export type Resolvers<ContextType = any> = {

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

@@ -6,9 +6,11 @@ import {
   DirectiveDefinitionNode,
   EnumTypeDefinitionNode,
   FieldDefinitionNode,
+  GraphQLInterfaceType,
   GraphQLNamedType,
   GraphQLObjectType,
   GraphQLSchema,
+  GraphQLUnionType,
   InputValueDefinitionNode,
   InterfaceTypeDefinitionNode,
   isEnumType,
@@ -33,8 +35,6 @@ import {
   ConvertOptions,
   DeclarationKind,
   EnumValuesMap,
-  type NormalizedGenerateInternalResolversIfNeededConfig,
-  type GenerateInternalResolversIfNeededConfig,
   NormalizedAvoidOptionalsConfig,
   NormalizedScalarsMap,
   ParsedEnumValuesMap,
@@ -77,7 +77,6 @@ export interface ParsedResolversConfig extends ParsedConfig {
   resolverTypeSuffix: string;
   allResolversTypeName: string;
   internalResolversPrefix: string;
-  generateInternalResolversIfNeeded: NormalizedGenerateInternalResolversIfNeededConfig;
   directiveResolverMappings: Record<string, string>;
   resolversNonOptionalTypename: ResolversNonOptionalTypenameConfig;
   avoidCheckingAbstractTypesRecursively: boolean;
@@ -584,15 +583,6 @@ export interface RawResolversConfig extends RawConfig {
    * If you are using `mercurius-js`, please set this field to empty string for better compatibility.
    */
   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;
   /**
    * @description Makes `__typename` of resolver mappings non-optional without affecting the base types.
    * @default false
@@ -671,6 +661,31 @@ export class BaseResolversVisitor<
       baseGeneratedTypename?: string;
     };
   } = {};
+  protected _parsedSchemaMeta: {
+    types: {
+      interface: Record<
+        string,
+        {
+          type: GraphQLInterfaceType;
+          implementingTypes: Record<string, GraphQLObjectType>;
+        }
+      >;
+      union: Record<
+        string,
+        {
+          type: GraphQLUnionType;
+          unionMembers: Record<string, GraphQLObjectType>;
+        }
+      >;
+    };
+    typesWithIsTypeOf: Record<string, true>;
+  } = {
+    types: {
+      interface: {},
+      union: {},
+    },
+    typesWithIsTypeOf: {},
+  };
   protected _collectedDirectiveResolvers: { [key: string]: string } = {};
   protected _variablesTransformer: OperationVariablesToObject;
   protected _usedMappers: { [key: string]: boolean } = {};
@@ -679,7 +694,6 @@ export class BaseResolversVisitor<
   protected _hasReferencedResolversUnionTypes = false;
   protected _hasReferencedResolversInterfaceTypes = false;
   protected _resolversUnionTypes: Record<string, string> = {};
-  protected _resolversUnionParentTypes: Record<string, string> = {};
   protected _resolversInterfaceTypes: Record<string, string> = {};
   protected _rootTypeNames = new Set<string>();
   protected _globalDeclarations = new Set<string>();
@@ -745,6 +759,11 @@ export class BaseResolversVisitor<
       this.config.namespacedImportName
     );
 
+    // 1. Parse schema meta at the start once,
+    // so we can use it in subsequent generate functions
+    this.parseSchemaMeta();
+
+    // 2. Generate types for resolvers
     this._resolversTypes = this.createResolversFields({
       applyWrapper: type => this.applyResolverTypeWrapper(type),
       clearWrapper: type => this.clearResolverTypeWrapper(type),
@@ -1006,7 +1025,7 @@ export class BaseResolversVisitor<
         const { unionMember, excludeTypes } = this.config.resolversNonOptionalTypename;
         res[typeName] = this.getAbstractMembersType({
           typeName,
-          memberTypes: schemaType.getTypes(),
+          memberTypes: Object.values(this._parsedSchemaMeta.types.union[schemaType.name].unionMembers),
           isTypenameNonOptional: unionMember && !excludeTypes?.includes(typeName),
         });
       }
@@ -1028,24 +1047,11 @@ export class BaseResolversVisitor<
       const schemaType = allSchemaTypes[typeName];
 
       if (isInterfaceType(schemaType)) {
-        const allTypesMap = this._schema.getTypeMap();
-        const implementingTypes: GraphQLObjectType[] = [];
-
-        for (const graphqlType of Object.values(allTypesMap)) {
-          if (graphqlType instanceof GraphQLObjectType) {
-            const allInterfaces = graphqlType.getInterfaces();
-
-            if (allInterfaces.some(int => int.name === schemaType.name)) {
-              implementingTypes.push(graphqlType);
-            }
-          }
-        }
-
         const { interfaceImplementingType, excludeTypes } = this.config.resolversNonOptionalTypename;
 
         res[typeName] = this.getAbstractMembersType({
           typeName,
-          memberTypes: implementingTypes,
+          memberTypes: Object.values(this._parsedSchemaMeta.types.interface[schemaType.name].implementingTypes),
           isTypenameNonOptional: interfaceImplementingType && !excludeTypes?.includes(typeName),
         });
       }
@@ -1584,6 +1590,46 @@ export class BaseResolversVisitor<
     return contextType;
   }
 
+  private parseSchemaMeta(): void {
+    const allSchemaTypes = this._schema.getTypeMap();
+    const typeNames = this._federation.filterTypeNames(Object.keys(allSchemaTypes));
+
+    for (const typeName of typeNames) {
+      const schemaType = allSchemaTypes[typeName];
+
+      if (isUnionType(schemaType)) {
+        this._parsedSchemaMeta.types.union[schemaType.name] = {
+          type: schemaType,
+          unionMembers: {},
+        };
+
+        const unionMemberTypes = schemaType.getTypes();
+        for (const type of unionMemberTypes) {
+          this._parsedSchemaMeta.types.union[schemaType.name].unionMembers[type.name] = type;
+          this._parsedSchemaMeta.typesWithIsTypeOf[type.name] = true;
+        }
+      }
+
+      if (isInterfaceType(schemaType)) {
+        this._parsedSchemaMeta.types.interface[schemaType.name] = {
+          type: schemaType,
+          implementingTypes: {},
+        };
+
+        for (const graphqlType of Object.values(allSchemaTypes)) {
+          if (graphqlType instanceof GraphQLObjectType) {
+            const allInterfaces = graphqlType.getInterfaces();
+
+            if (allInterfaces.some(int => int.name === schemaType.name)) {
+              this._parsedSchemaMeta.types.interface[schemaType.name].implementingTypes[graphqlType.name] = graphqlType;
+              this._parsedSchemaMeta.typesWithIsTypeOf[graphqlType.name] = true;
+            }
+          }
+        }
+      }
+    }
+  }
+
   protected applyRequireFields(argsType: string, fields: InputValueDefinitionNode[]): string {
     this._globalDeclarations.add(REQUIRE_FIELDS_TYPE);
     return `RequireFields<${argsType}, ${fields.map(f => `'${f.name.value}'`).join(' | ')}>`;
@@ -1624,7 +1670,7 @@ export class BaseResolversVisitor<
       ).value;
     });
 
-    if (!rootType) {
+    if (!rootType && this._parsedSchemaMeta.typesWithIsTypeOf[typeName]) {
       fieldsContent.push(
         indent(
           `${

packages/plugins/other/visitor-plugin-common/src/types.ts

@@ -138,6 +138,3 @@ export interface CustomDirectivesConfig {
    */
   apolloUnmask?: boolean;
 }
-
-export interface GenerateInternalResolversIfNeededConfig {}
-export type NormalizedGenerateInternalResolversIfNeededConfig = Required<GenerateInternalResolversIfNeededConfig>;

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

@@ -181,7 +181,6 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - Interface', () => {
       export type PersonNameResolvers<ContextType = any, ParentType extends ResolversParentTypes['PersonName'] = ResolversParentTypes['PersonName']> = {
         first?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
         last?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-        __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
       };
 
       export type Resolvers<ContextType = any> = {

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

@@ -147,13 +147,11 @@ describe('TypeScript Resolvers Plugin + Apollo Federation - mappers', () => {
         __resolveReference?: ReferenceResolver<Maybe<ResolversTypes['User']>, { __typename: 'User' } & GraphQLRecursivePick<FederationType, {"id":true}>, ContextType>;
         id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
         name?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-        __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
       };
 
       export type UserProfileResolvers<ContextType = any, ParentType extends ResolversParentTypes['UserProfile'] = ResolversParentTypes['UserProfile']> = {
         id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
         user?: Resolver<ResolversTypes['User'], ParentType, ContextType>;
-        __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
       };
 
       export type Resolvers<ContextType = any> = {