Ensure object types across multiple schemas have __isTypeOf in Pick values (#319)

* Make sure __isTypeOf is in the picked properties

* Update e2e tests

* Add changeset

Author: eddeee888

.changeset/seven-camels-compete.md

@@ -0,0 +1,5 @@
+---
+'@eddeee888/gcg-typescript-resolver-files': patch
+---
+
+Ensure \_\_isTypeOf is in the picked properties so users can choose this way to handle abstract type should they choose

packages/typescript-resolver-files-e2e/src/test-extended-object-types/schema-base/book-store-v2_new_again-final_v3/resolvers/Topic.ts

@@ -1,7 +1,8 @@
 import type { TopicResolvers } from './../../types.generated';
-export const Topic: Pick<TopicResolvers, 'bookStore_for_topic'> = {
-  /* Implement Topic resolver logic here */
-  bookStore_for_topic: async (_parent, _arg, _ctx) => {
-    /* Topic.bookStore_for_topic resolver is required because Topic.bookStore_for_topic exists but TopicMapper.bookStore_for_topic does not */
-  },
-};
+export const Topic: Pick<TopicResolvers, 'bookStore_for_topic' | '__isTypeOf'> =
+  {
+    /* Implement Topic resolver logic here */
+    bookStore_for_topic: async (_parent, _arg, _ctx) => {
+      /* Topic.bookStore_for_topic resolver is required because Topic.bookStore_for_topic exists but TopicMapper.bookStore_for_topic does not */
+    },
+  };

packages/typescript-resolver-files-e2e/src/test-extended-object-types/schema-base/book-store-v2_new_again-final_v3/resolvers/User.ts

@@ -1,4 +1,4 @@
 import type { UserResolvers } from './../../types.generated';
-export const User: Pick<UserResolvers, 'bookStore_4_user'> = {
+export const User: Pick<UserResolvers, 'bookStore_4_user' | '__isTypeOf'> = {
   /* Implement User resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-extended-object-types/schema-base/topic/resolvers/Topic.ts

@@ -11,6 +11,7 @@ export const Topic: Pick<
   | 'id'
   | 'name'
   | 'url'
+  | '__isTypeOf'
 > = {
   /* Implement Topic resolver logic here */
   extendedTopicFieldInDifferentFileAndSameModule1: async (

packages/typescript-resolver-files-e2e/src/test-extended-object-types/schema-base/user/resolvers/Topic.ts

@@ -5,6 +5,7 @@ export const Topic: Pick<
   | 'extendedTopicFieldInDifferentFileAndDifferentModule1'
   | 'extendedTopicFieldInDifferentFileAndDifferentModule2'
   | 'extendedTopicFieldInDifferentFileAndDifferentModule3'
+  | '__isTypeOf'
 > = {
   /* Implement Topic resolver logic here */
   creator: ({ creator }, _arg, _ctx) => {

packages/typescript-resolver-files-e2e/src/test-extended-object-types/schema-base/user/resolvers/User.ts

@@ -9,6 +9,7 @@ export const User: Pick<
   | 'avatar'
   | 'id'
   | 'name'
+  | '__isTypeOf'
 > = {
   /* Implement User resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-extended-object-types/schema-federated-extended-object-type/topic/resolvers/ForeignType.ts

@@ -1,7 +1,7 @@
 import type { ForeignTypeResolvers } from './../../types.generated';
 export const ForeignType: Pick<
   ForeignTypeResolvers,
-  'id' | 'topics' | '__resolveReference'
+  'id' | 'topics' | '__isTypeOf' | '__resolveReference'
 > = {
   /* Implement ForeignType resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-extended-object-types/schema-federated-extended-object-type/user/resolvers/ForeignType.ts

@@ -1,7 +1,7 @@
 import type { ForeignTypeResolvers } from './../../types.generated';
 export const ForeignType: Pick<
   ForeignTypeResolvers,
-  'users' | '__resolveReference'
+  'users' | '__isTypeOf' | '__resolveReference'
 > = {
   /* Implement ForeignType resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/schools-domain/course/resolvers/School.ts

@@ -1,4 +1,4 @@
 import type { SchoolResolvers } from './../../../types.generated';
-export const School: Pick<SchoolResolvers, 'courses'> = {
+export const School: Pick<SchoolResolvers, 'courses' | '__isTypeOf'> = {
   /* Implement School resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/schools-domain/demographics/resolvers/School.ts

@@ -1,4 +1,4 @@
 import type { SchoolResolvers } from './../../../types.generated';
-export const School: Pick<SchoolResolvers, 'demographics'> = {
+export const School: Pick<SchoolResolvers, 'demographics' | '__isTypeOf'> = {
   /* Implement School resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/schools-domain/school/resolvers/School.ts

@@ -1,4 +1,4 @@
 import type { SchoolResolvers } from './../../../types.generated';
-export const School: Pick<SchoolResolvers, 'id' | 'name'> = {
+export const School: Pick<SchoolResolvers, 'id' | 'name' | '__isTypeOf'> = {
   /* Implement School resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/students-domain/avatar/resolvers/StudentProfile.ts

@@ -1,4 +1,7 @@
 import type { StudentProfileResolvers } from './../../../types.generated';
-export const StudentProfile: Pick<StudentProfileResolvers, 'avatar'> = {
+export const StudentProfile: Pick<
+  StudentProfileResolvers,
+  'avatar' | '__isTypeOf'
+> = {
   /* Implement StudentProfile resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/students-domain/guardians/resolvers/Student.ts

@@ -1,4 +1,4 @@
 import type { StudentResolvers } from './../../../types.generated';
-export const Student: Pick<StudentResolvers, 'guardians'> = {
+export const Student: Pick<StudentResolvers, 'guardians' | '__isTypeOf'> = {
   /* Implement Student resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/students-domain/profile/resolvers/Student.ts

@@ -1,4 +1,4 @@
 import type { StudentResolvers } from './../../../types.generated';
-export const Student: Pick<StudentResolvers, 'profile'> = {
+export const Student: Pick<StudentResolvers, 'profile' | '__isTypeOf'> = {
   /* Implement Student resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/students-domain/profile/resolvers/StudentProfile.ts

@@ -1,7 +1,7 @@
 import type { StudentProfileResolvers } from './../../../types.generated';
 export const StudentProfile: Pick<
   StudentProfileResolvers,
-  'email' | 'firstName' | 'id' | 'lastName' | 'phoneNumber'
+  'email' | 'firstName' | 'id' | 'lastName' | 'phoneNumber' | '__isTypeOf'
 > = {
   /* Implement StudentProfile resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/students-domain/student/resolvers/Student.ts

@@ -1,4 +1,4 @@
 import type { StudentResolvers } from './../../../types.generated';
-export const Student: Pick<StudentResolvers, 'id'> = {
+export const Student: Pick<StudentResolvers, 'id' | '__isTypeOf'> = {
   /* Implement Student resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/teachers-domain/avatar/resolvers/TeacherProfile.ts

@@ -1,4 +1,7 @@
 import type { TeacherProfileResolvers } from './../../../types.generated';
-export const TeacherProfile: Pick<TeacherProfileResolvers, 'avatar'> = {
+export const TeacherProfile: Pick<
+  TeacherProfileResolvers,
+  'avatar' | '__isTypeOf'
+> = {
   /* Implement TeacherProfile resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/teachers-domain/profile/resolvers/Teacher.ts

@@ -1,4 +1,4 @@
 import type { TeacherResolvers } from './../../../types.generated';
-export const Teacher: Pick<TeacherResolvers, 'profile'> = {
+export const Teacher: Pick<TeacherResolvers, 'profile' | '__isTypeOf'> = {
   /* Implement Teacher resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/teachers-domain/profile/resolvers/TeacherProfile.ts

@@ -1,7 +1,7 @@
 import type { TeacherProfileResolvers } from './../../../types.generated';
 export const TeacherProfile: Pick<
   TeacherProfileResolvers,
-  'email' | 'firstName' | 'id' | 'lastName' | 'phoneNumber'
+  'email' | 'firstName' | 'id' | 'lastName' | 'phoneNumber' | '__isTypeOf'
 > = {
   /* Implement TeacherProfile resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-nested-domain-modules/teachers-domain/teacher/resolvers/Teacher.ts

@@ -1,4 +1,4 @@
 import type { TeacherResolvers } from './../../../types.generated';
-export const Teacher: Pick<TeacherResolvers, 'id'> = {
+export const Teacher: Pick<TeacherResolvers, 'id' | '__isTypeOf'> = {
   /* Implement Teacher resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-resolver-generation/schema-disabled/topic/resolvers/User.ts

@@ -8,7 +8,7 @@ import type { UserResolvers } from './../../types.generated';
  *
  * If you want to skip this file generation, remove the mapper or update the pattern in the `resolverGeneration.object` config.
  */
-export const User: Pick<UserResolvers, 'topics'> = {
+export const User: Pick<UserResolvers, 'topics' | '__isTypeOf'> = {
   /* Implement User resolver logic here */
   topics: async (_parent, _arg, _ctx) => {
     /* User.topics resolver is required because User.topics exists but UserMapper.topics does not */

packages/typescript-resolver-files-e2e/src/test-resolver-generation/schema-disabled/user/resolvers/User.ts

@@ -18,6 +18,7 @@ export const User: Pick<
   | 'avatar'
   | 'id'
   | 'name'
+  | '__isTypeOf'
 > = {
   /* Implement User resolver logic here */
   accountGitHub: async (_parent, _arg, _ctx) => {

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/pet/resolvers/User.ts

@@ -1,4 +1,4 @@
 import type { UserResolvers } from './../../types.generated';
-export const User: Pick<UserResolvers, 'pets'> = {
+export const User: Pick<UserResolvers, 'pets' | '__isTypeOf'> = {
   /* Implement User resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/zoo/resolvers/Profile.ts

@@ -1,4 +1,4 @@
 import type { ProfileResolvers } from './../../types.generated';
-export const Profile: Pick<ProfileResolvers, 'zoo'> = {
+export const Profile: Pick<ProfileResolvers, 'zoo' | '__isTypeOf'> = {
   /* Implement Profile resolver logic here */
 };

packages/typescript-resolver-files/src/generateResolverFiles/handleGraphQLObjectType.ts

@@ -64,35 +64,38 @@ export const handleGraphQLObjectType: GraphQLTypeHandler<
     return '';
   })();
 
-  if (fieldsToPick.length > 0 && pickReferenceResolver) {
+  const hasFieldsToPick = fieldsToPick.length > 0;
+
+  // __isTypeOf is required to resolve abstract types, should user chooses this approach.
+  // TODO: Run static analysis to enforce only one __isTypeOf per Object type, so users cannot accidentally implement/override it across modules
+  if (hasFieldsToPick) {
+    fieldsToPick.push('__isTypeOf');
+  }
+
+  if (hasFieldsToPick && pickReferenceResolver) {
     fieldsToPick.push('__resolveReference');
   }
 
   // `typeString` contains the resolver type
   // If there's fieldsToPick, we must only pick said fields from the original resolver type
-  const typeString =
-    fieldsToPick.length > 0
-      ? `Pick<${resolversTypeMeta.typeString}, ${fieldsToPick
-          .map((fieldName) => `'${fieldName}'`)
-          .join('|')}>`
-      : resolversTypeMeta.typeString;
+  const typeString = hasFieldsToPick
+    ? `Pick<${resolversTypeMeta.typeString}, ${fieldsToPick
+        .map((fieldName) => `'${fieldName}'`)
+        .join('|')}>`
+    : resolversTypeMeta.typeString;
 
   // Array of all resolvers that may need type checking
   // If there's fieldsToPick, we must only generate said fields
   const allResolversToGenerate =
     graphQLObjectTypeResolversToGenerate[resolverName];
-  const resolversToGenerate =
-    fieldsToPick.length > 0
-      ? fieldsToPick.reduce<typeof allResolversToGenerate>(
-          (res, fieldToPick) => {
-            if (allResolversToGenerate) {
-              res[fieldToPick] = allResolversToGenerate[fieldToPick];
-            }
-            return res;
-          },
-          {}
-        )
-      : allResolversToGenerate;
+  const resolversToGenerate = hasFieldsToPick
+    ? fieldsToPick.reduce<typeof allResolversToGenerate>((res, fieldToPick) => {
+        if (allResolversToGenerate && allResolversToGenerate[fieldToPick]) {
+          res[fieldToPick] = allResolversToGenerate[fieldToPick];
+        }
+        return res;
+      }, {})
+    : allResolversToGenerate;
 
   const variableStatement = `${forcedGenerationWarning}export const ${resolverName}: ${typeString} = {
     /* Implement ${resolverName} resolver logic here */