Fix scalar overrides not giving full control to user (#320)

* Update e2e test for unmanaged scalar case

* Fix issue where scalarsOverride do not give full control to user

* Clarify whether a file has been added on filesystem

* Ensure unmanagedScalarResolvers have higher priority than scalarsModule

* Add changeset

* Fix unit tests

Author: eddeee888

.changeset/early-terms-turn.md

@@ -0,0 +1,5 @@
+---
+'@eddeee888/gcg-typescript-resolver-files': patch
+---
+
+Fix scalarOverrides not giving full control to users

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/codegen.ts

@@ -8,7 +8,18 @@ const config: CodegenConfig = {
   generates: {
     'packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema':
       defineConfig(
-        { resolverGeneration: 'minimal', blacklistedModules: ['user'] },
+        {
+          resolverGeneration: 'minimal',
+          blacklistedModules: ['user'],
+          externalResolvers: {
+            PetHouse: 'pet/resolvers/PetHouse#PetHouseResolvers',
+          },
+          scalarsOverrides: {
+            Date: {
+              resolver: 'base/resolvers/Date#DateResolver',
+            },
+          },
+        },
         {
           schema: [
             'packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/**/*.graphqls',

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/base/base.graphqls

@@ -40,6 +40,7 @@ type PaginationResult {
 }
 
 scalar DateTime
+scalar Date
 scalar SomeRandomScalar
 scalar CustomLogicScalar
 scalar JSON

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/base/resolvers/Date.ts

@@ -0,0 +1,3 @@
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
+
+export const DateResolver = {}

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/base/resolvers/Error.ts

@@ -1,4 +1,5 @@
 import type { ErrorResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
 export const Error: ErrorResolvers = {
   /* Implement Error interface logic here */
 };

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/base/resolvers/ErrorType.ts

@@ -1,4 +1,5 @@
 import type { ErrorTypeResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
 /*
  * Note: This enum file is generated because "ErrorTypeMapper" is declared. This is to ensure runtime safety.
  * If you want to skip this file generation, remove the mapper or update the pattern in the `resolverGeneration.object` config.

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/base/resolvers/SortOrder.ts

@@ -1,4 +1,6 @@
 import type { SortOrderResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
+
 export const SortOrder: SortOrderResolvers = {
   ASC: 'ASCENDING',
   DESC: 'DESC',

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

@@ -1,2 +1,4 @@
 import type { PetResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
+
 export const Pet: PetResolvers = {};

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

@@ -0,0 +1,3 @@
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
+
+export const PetHouseResolvers = {};

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

@@ -1,2 +1,4 @@
 import type { PetToyResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
+
 export const PetToy: PetToyResolvers = {};

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

@@ -1,4 +1,5 @@
 import type { UserResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
 export const User: Pick<UserResolvers, 'pets' | '__isTypeOf'> = {
   /* Implement User resolver logic here */
 };

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

@@ -12,3 +12,7 @@ type PetToy {
 extend type User {
   pets: [Pet!]!
 }
+
+type PetHouse {
+  id: ID!
+}

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

@@ -0,0 +1,3 @@
+export type PetHouseMapper = {
+  petHouseId: string;
+};

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

@@ -19,6 +19,8 @@ import { TopicCreatePayload } from './topic/resolvers/TopicCreatePayload';
 import { Country } from './base/resolvers/Country';
 import { ErrorType } from './base/resolvers/ErrorType';
 import { SortOrder } from './base/resolvers/SortOrder';
+import { PetHouseResolvers } from './pet/resolvers/PetHouse';
+import { DateResolver } from './base/resolvers/Date';
 import { DateTimeResolver } from 'graphql-scalars';
 export const resolvers: Resolvers = {
   Query: {
@@ -45,5 +47,7 @@ export const resolvers: Resolvers = {
   Country: Country,
   ErrorType: ErrorType,
   SortOrder: SortOrder,
+  PetHouse: PetHouseResolvers,
+  Date: DateResolver,
   DateTime: DateTimeResolver,
 };

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/schema.generated.graphqls

@@ -6,6 +6,8 @@ enum Country {
 
 scalar CustomLogicScalar
 
+scalar Date
+
 scalar DateTime
 
 interface Error {
@@ -47,6 +49,10 @@ type Pet {
   primaryOwner: User!
 }
 
+type PetHouse {
+  id: ID!
+}
+
 type PetToy {
   id: ID!
   name: String!

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/topic/resolvers/RandomFile_ShouldHaveEmptyContent.ts

@@ -0,0 +1,2 @@
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
+

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/topic/resolvers/TopicCreatePayload.ts

@@ -1,4 +1,5 @@
 import type { TopicCreatePayloadResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
 export const TopicCreatePayload: TopicCreatePayloadResolvers = {
   /* Implement TopicCreatePayload union logic here */
 };

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/topic/resolvers/TopicCreateResult.ts

@@ -1,4 +1,5 @@
 import type { TopicCreateResultResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
 export const TopicCreateResult: TopicCreateResultResolvers = {
   /* Implement TopicCreateResult resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/topic/resolvers/TopicEditResult.ts

@@ -1,4 +1,5 @@
 import type { TopicEditResultResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
 /*
  * Note: This object type is generated because "TopicEditResultMapper" is declared. This is to ensure runtime safety.
  *

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/typeDefs.generated.ts

@@ -354,6 +354,11 @@ export const typeDefs = {
       name: { kind: 'Name', value: 'DateTime' },
       directives: [],
     },
+    {
+      kind: 'ScalarTypeDefinition',
+      name: { kind: 'Name', value: 'Date' },
+      directives: [],
+    },
     {
       kind: 'ScalarTypeDefinition',
       name: { kind: 'Name', value: 'SomeRandomScalar' },
@@ -533,6 +538,24 @@ export const typeDefs = {
       directives: [],
       interfaces: [],
     },
+    {
+      kind: 'ObjectTypeDefinition',
+      name: { kind: 'Name', value: 'PetHouse' },
+      interfaces: [],
+      directives: [],
+      fields: [
+        {
+          kind: 'FieldDefinition',
+          name: { kind: 'Name', value: 'id' },
+          arguments: [],
+          type: {
+            kind: 'NonNullType',
+            type: { kind: 'NamedType', name: { kind: 'Name', value: 'ID' } },
+          },
+          directives: [],
+        },
+      ],
+    },
     {
       kind: 'ObjectTypeDefinition',
       name: { kind: 'Name', value: 'Topic' },

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/types.generated.ts

@@ -8,6 +8,7 @@ import {
   ErrorTypeMapper,
   SortOrderMapper,
 } from './base/base.mappers';
+import { PetHouseMapper } from './pet/schema.mappers';
 import { TopicMapper, TopicEditResultMapper } from './topic/topic.mappers';
 export type Maybe<T> = T | null | undefined;
 export type InputMaybe<T> = T | null | undefined;
@@ -44,6 +45,7 @@ export type Scalars = {
   Int: { input: number; output: number };
   Float: { input: number; output: number };
   CustomLogicScalar: { input: any; output: any };
+  Date: { input: Date | string; output: Date | string };
   DateTime: { input: Date | string; output: Date | string };
   JSON: { input: any; output: any };
   SomeRandomScalar: { input: any; output: any };
@@ -99,6 +101,11 @@ export type Pet = {
   primaryOwner: User;
 };
 
+export type PetHouse = {
+  __typename?: 'PetHouse';
+  id: Scalars['ID']['output'];
+};
+
 export type PetToy = {
   __typename?: 'PetToy';
   id: Scalars['ID']['output'];
@@ -373,6 +380,7 @@ export type ResolversTypes = {
   CustomLogicScalar: ResolverTypeWrapper<
     Scalars['CustomLogicScalar']['output']
   >;
+  Date: ResolverTypeWrapper<Scalars['Date']['output']>;
   DateTime: ResolverTypeWrapper<Scalars['DateTime']['output']>;
   Error: ResolverTypeWrapper<ResolversInterfaceTypes<ResolversTypes>['Error']>;
   ErrorType: ResolverTypeWrapper<ErrorTypeMapper>;
@@ -387,6 +395,7 @@ export type ResolversTypes = {
   Pet: ResolverTypeWrapper<Pet>;
   ID: ResolverTypeWrapper<Scalars['ID']['output']>;
   String: ResolverTypeWrapper<Scalars['String']['output']>;
+  PetHouse: ResolverTypeWrapper<PetHouseMapper>;
   PetToy: ResolverTypeWrapper<PetToy>;
   Profile: ResolverTypeWrapper<Profile>;
   Query: ResolverTypeWrapper<{}>;
@@ -435,6 +444,7 @@ export type ResolversTypes = {
 /** Mapping between all available schema types and the resolvers parents */
 export type ResolversParentTypes = {
   CustomLogicScalar: Scalars['CustomLogicScalar']['output'];
+  Date: Scalars['Date']['output'];
   DateTime: Scalars['DateTime']['output'];
   Error: ResolversInterfaceTypes<ResolversParentTypes>['Error'];
   JSON: Scalars['JSON']['output'];
@@ -446,6 +456,7 @@ export type ResolversParentTypes = {
   Pet: Pet;
   ID: Scalars['ID']['output'];
   String: Scalars['String']['output'];
+  PetHouse: PetHouseMapper;
   PetToy: PetToy;
   Profile: Profile;
   Query: {};
@@ -486,6 +497,11 @@ export interface CustomLogicScalarScalarConfig
   name: 'CustomLogicScalar';
 }
 
+export interface DateScalarConfig
+  extends GraphQLScalarTypeConfig<ResolversTypes['Date'], any> {
+  name: 'Date';
+}
+
 export interface DateTimeScalarConfig
   extends GraphQLScalarTypeConfig<ResolversTypes['DateTime'], any> {
   name: 'DateTime';
@@ -560,6 +576,14 @@ export type PetResolvers<
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 };
 
+export type PetHouseResolvers<
+  ContextType = any,
+  ParentType extends ResolversParentTypes['PetHouse'] = ResolversParentTypes['PetHouse']
+> = {
+  id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
+  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
+};
+
 export type PetToyResolvers<
   ContextType = any,
   ParentType extends ResolversParentTypes['PetToy'] = ResolversParentTypes['PetToy']
@@ -777,6 +801,7 @@ export type ZooResolvers<
 export type Resolvers<ContextType = any> = {
   Country?: CountryResolvers;
   CustomLogicScalar?: GraphQLScalarType;
+  Date?: GraphQLScalarType;
   DateTime?: GraphQLScalarType;
   Error?: ErrorResolvers<ContextType>;
   ErrorType?: ErrorTypeResolvers;
@@ -785,6 +810,7 @@ export type Resolvers<ContextType = any> = {
   PaginationResult?: PaginationResultResolvers<ContextType>;
   PayloadError?: PayloadErrorResolvers<ContextType>;
   Pet?: PetResolvers<ContextType>;
+  PetHouse?: PetHouseResolvers<ContextType>;
   PetToy?: PetToyResolvers<ContextType>;
   Profile?: ProfileResolvers<ContextType>;
   Query?: QueryResolvers<ContextType>;

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

@@ -0,0 +1,2 @@
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
+

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

@@ -1,4 +1,5 @@
 import type { ProfileResolvers } from './../../types.generated';
+/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */
 export const Profile: Pick<ProfileResolvers, 'zoo' | '__isTypeOf'> = {
   /* Implement Profile resolver logic here */
 };

packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/test-setup.js

@@ -56,6 +56,19 @@ try {
       `,
     },
 
+    // `externalOverrides` gives full control to user
+    {
+      file: 'packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/pet/resolvers/PetHouse.ts',
+      content: `export const PetHouseResolvers = {};`,
+    },
+
+    // `scalarOverrides` must give full control to user
+    // https://github.com/eddeee888/graphql-code-generator-plugins/issues/306
+    {
+      file: 'packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/base/resolvers/Date.ts',
+      content: `export const DateResolver = {}`,
+    },
+
     // Files in blacklisted modules should not be filled or added to resolvers.generated.ts
     'packages/typescript-resolver-files-e2e/src/test-resolvers-auto-wireup/schema/user/resolvers/User.ts',
 
@@ -79,7 +92,10 @@ try {
 
     const dir = path.dirname(filename);
     fs.mkdirSync(dir, { recursive: true });
-    fs.writeFileSync(filename, content);
+    fs.writeFileSync(
+      filename,
+      `/* This file has been created on filesystem by src/test-resolvers/auto-wireup/test-setup.js */\n\n${content}`
+    );
   });
 } catch (err) {
   console.error(err);

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

@@ -16,7 +16,11 @@ interface AddExternalResolverImportParams {
 /**
  * addExternalResolverImport
  *
- * 1. parse external resolvers (originally from config.externalResolvers) import syntax
+ * External resolvers are resolvers that are not managed by server preset:
+ * - unmanaged resolvers e.g. using config.externalResolvers or config.scalarsOverrides
+ * - resolvers that come from an external module e.g. `graphql-scalars`
+ *
+ * 1. parse external resolvers (originally from ) import syntax
  * 2. dedupes any duplicated imports
  * 3. declares the which identifier name to use for GraphQL object or resolver in identifierUsages
  */

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

@@ -133,7 +133,7 @@ export interface GenerateResolverFilesContext {
     resolverMainFile: string;
     resolverMainFileMode: ParsedPresetConfig['resolverMainFileMode'];
     resolverGeneration: ParsedPresetConfig['resolverGeneration'];
-    externalResolvers: Record<string, string>;
+    unmanagedResolvers: Record<string, string>;
     tsMorph: {
       project: Project;
       typesSourceFile: SourceFile;

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

@@ -19,18 +19,15 @@ export const visitNamedType = <T = null>(
   },
   ctx: GenerateResolverFilesContext
 ): void => {
-  const externalResolverImportSyntax =
-    ctx.config.externalResolvers[normalizedResolverName.base];
-
-  // when used with extended object types scenario
-  if (externalResolverImportSyntax) {
-    // If has external resolver, use it
+  const unmanagedResolversImportSyntax =
+    ctx.config.unmanagedResolvers[normalizedResolverName.base];
+  if (unmanagedResolversImportSyntax) {
     addExternalResolverImport(
       {
         moduleName,
         relativePathFromBaseToModule,
         normalizedResolverName: normalizedResolverName.base,
-        configImportSyntax: externalResolverImportSyntax,
+        configImportSyntax: unmanagedResolversImportSyntax,
       },
       ctx
     );