fix passing pluck config via graphql-config#extensions field (#1198)

rename `extensions.graphqlTagPluck` to `extensions.pluckConfig`
fix performance regression while using `processor: '@graphql-eslint/graphql'`

Author: dimaMachina

.changeset/curly-carrots-call.md

@@ -0,0 +1,7 @@
+---
+'@graphql-eslint/eslint-plugin': patch
+---
+
+fix passing pluck config via `graphql-config#extensions` field
+rename `extensions.graphqlTagPluck` to `extensions.pluckConfig`
+fix performance regression while using `processor: '@graphql-eslint/graphql'`

packages/plugin/package.json

@@ -34,14 +34,14 @@
     "prepack": "bob prepack"
   },
   "dependencies": {
-    "@babel/code-frame": "^7.16.7",
-    "@graphql-tools/code-file-loader": "^7.2.14",
-    "@graphql-tools/graphql-tag-pluck": "^7.2.6",
-    "@graphql-tools/utils": "^8.6.9",
+    "@babel/code-frame": "^7.18.6",
+    "@graphql-tools/code-file-loader": "^7.3.6",
+    "@graphql-tools/graphql-tag-pluck": "^7.3.6",
+    "@graphql-tools/utils": "^8.12.0",
     "chalk": "^4.1.2",
     "debug": "^4.3.4",
-    "fast-glob": "^3.2.11",
-    "graphql-config": "^4.3.0",
+    "fast-glob": "^3.2.12",
+    "graphql-config": "^4.3.5",
     "graphql-depth-limit": "^1.1.0",
     "lodash.lowercase": "^4.3.0"
   },

packages/plugin/src/graphql-config.ts

@@ -6,23 +6,32 @@ import {
   loadConfigSync,
   SchemaPointer,
 } from 'graphql-config';
+import { GraphQLTagPluckOptions } from '@graphql-tools/graphql-tag-pluck';
 import { CodeFileLoader } from '@graphql-tools/code-file-loader';
 import { ParserOptions } from './types';
 
 const debug = debugFactory('graphql-eslint:graphql-config');
 let graphQLConfig: GraphQLConfig;
 
 export function loadOnDiskGraphQLConfig(filePath: string): GraphQLConfig {
-  return loadConfigSync({
+  const rootDir = dirname(filePath);
+  const config = loadConfigSync({
     // load config relative to the file being linted
-    rootDir: filePath ? dirname(filePath) : undefined,
+    rootDir,
     throwOnEmpty: false,
     throwOnMissing: false,
-    extensions: [addCodeFileLoaderExtension],
+  });
+  if (!config) {
+    return null;
+  }
+  const project = config.getProjectForFile(filePath);
+  return loadConfigSync({
+    rootDir,
+    extensions: [codeFileLoaderExtension(project.extensions.pluckConfig)],
   });
 }
 
-export function loadGraphQLConfig(options: ParserOptions = {}): GraphQLConfig {
+export function loadGraphQLConfig(options: ParserOptions): GraphQLConfig {
   // We don't want cache config on test environment
   // Otherwise schema and documents will be same for all tests
   if (process.env.NODE_ENV !== 'test' && graphQLConfig) {
@@ -53,14 +62,17 @@ export function loadGraphQLConfig(options: ParserOptions = {}): GraphQLConfig {
         config: configOptions,
         filepath: 'virtual-config',
       },
-      [addCodeFileLoaderExtension]
+      [codeFileLoaderExtension(options.extensions?.pluckConfig)]
     );
 
   return graphQLConfig;
 }
 
-const addCodeFileLoaderExtension: GraphQLExtensionDeclaration = api => {
-  api.loaders.schema.register(new CodeFileLoader());
-  api.loaders.documents.register(new CodeFileLoader());
-  return { name: 'graphql-eslint-loaders' };
-};
+const codeFileLoaderExtension =
+  (pluckConfig: GraphQLTagPluckOptions): GraphQLExtensionDeclaration =>
+  api => {
+    const { schema, documents } = api.loaders;
+    schema.register(new CodeFileLoader({ pluckConfig }));
+    documents.register(new CodeFileLoader({ pluckConfig }));
+    return { name: 'graphql-eslint-loaders' };
+  };

packages/plugin/src/parser.ts

@@ -12,13 +12,10 @@ const debug = debugFactory('graphql-eslint:parser');
 
 debug('cwd %o', process.cwd());
 
-export function parseForESLint(
-  code: string,
-  options: ParserOptions = {}
-): GraphQLESLintParseResult {
+export function parseForESLint(code: string, options: ParserOptions): GraphQLESLintParseResult {
   try {
-    const filePath = options.filePath || '';
-    const realFilepath = filePath && getOnDiskFilepath(filePath);
+    const { filePath } = options;
+    const realFilepath = getOnDiskFilepath(filePath);
 
     const gqlConfig = loadGraphQLConfig(options);
     const projectForFile = realFilepath

packages/plugin/src/processor.ts

@@ -12,28 +12,37 @@ export type Block = Linter.ProcessorFile & {
 const blocksMap = new Map<string, Block[]>();
 
 let onDiskConfig: GraphQLConfig;
+let pluckConfig: GraphQLTagPluckOptions;
+let RELEVANT_KEYWORDS: string[];
 
 export const processor: Linter.Processor<Block | string> = {
   supportsAutofix: true,
   preprocess(code, filePath) {
-    onDiskConfig ||= loadOnDiskGraphQLConfig(filePath);
-    const graphQLTagPluckOptions: GraphQLTagPluckOptions =
-      onDiskConfig?.getProjectForFile?.(filePath)?.extensions?.graphqlTagPluck;
-    const {
-      modules = [],
-      globalGqlIdentifierName = ['gql', 'graphql'],
-      gqlMagicComment = 'GraphQL',
-    } = graphQLTagPluckOptions || {};
+    if (!pluckConfig) {
+      onDiskConfig = loadOnDiskGraphQLConfig(filePath);
+      const {
+        modules = [],
+        globalGqlIdentifierName = ['gql', 'graphql'],
+        gqlMagicComment = 'GraphQL',
+      } = onDiskConfig?.getProjectForFile(filePath).extensions.pluckConfig || {};
 
-    const RELEVANT_KEYWORDS: string[] = [
-      ...new Set(
-        [
-          ...modules.map(({ identifier }) => identifier),
-          ...asArray(globalGqlIdentifierName),
-          gqlMagicComment,
-        ].filter(Boolean)
-      ),
-    ];
+      pluckConfig = {
+        skipIndent: true,
+        modules,
+        globalGqlIdentifierName,
+        gqlMagicComment,
+      };
+
+      RELEVANT_KEYWORDS = [
+        ...new Set(
+          [
+            ...modules.map(({ identifier }) => identifier),
+            ...asArray(globalGqlIdentifierName),
+            gqlMagicComment,
+          ].filter(Boolean)
+        ),
+      ];
+    }
 
     if (RELEVANT_KEYWORDS.every(keyword => !code.includes(keyword))) {
       return [code];
@@ -43,10 +52,7 @@ export const processor: Linter.Processor<Block | string> = {
       const extractedDocuments = parseCode({
         code,
         filePath,
-        options: {
-          skipIndent: true,
-          ...graphQLTagPluckOptions,
-        },
+        options: pluckConfig,
       });
 
       const blocks: Block[] = extractedDocuments.map(item => ({

packages/plugin/src/schema.ts

@@ -11,7 +11,7 @@ const debug = debugFactory('graphql-eslint:schema');
 
 export function getSchema(
   projectForFile: GraphQLProjectConfig,
-  options: ParserOptions = {}
+  options: Omit<ParserOptions, 'filePath'> = {}
 ): Schema {
   const schemaKey = asArray(projectForFile.schema).sort().join(',');
 

packages/plugin/src/testkit.ts

@@ -37,10 +37,10 @@ function applyFix(code: string, { range, text }: Rule.Fix): string {
 export class GraphQLRuleTester extends RuleTester {
   config: {
     parser: string;
-    parserOptions: ParserOptions;
+    parserOptions: Omit<ParserOptions, 'filePath'>;
   };
 
-  constructor(parserOptions: ParserOptions = {}) {
+  constructor(parserOptions: Omit<ParserOptions, 'filePath'> = {}) {
     const config = {
       parser: require.resolve('@graphql-eslint/eslint-plugin'),
       parserOptions: {

packages/plugin/src/types.ts

@@ -22,7 +22,7 @@ export interface ParserOptions {
   };
   graphQLParserOptions?: Omit<GraphQLParseOptions, 'noLocation'>;
   skipGraphQLConfig?: boolean;
-  filePath?: string;
+  filePath: string;
 }
 
 export type ParserServices = {

packages/plugin/tests/processor-with-graphql-config.spec.ts

@@ -4,7 +4,7 @@ jest.mock('../src/graphql-config', () => ({
   loadOnDiskGraphQLConfig: jest.fn(() => ({
     getProjectForFile: () => ({
       extensions: {
-        graphqlTagPluck: {
+        pluckConfig: {
           modules: [{ name: 'custom-gql-tag', identifier: 'custom' }],
           gqlMagicComment: 'CustoM',
         },

packages/plugin/tests/schema.spec.ts

@@ -12,7 +12,7 @@ describe('schema', () => {
   const schemaOnDisk = readFileSync(SCHEMA_GRAPHQL_PATH, 'utf8');
 
   const testSchema = (schema: string) => {
-    const gqlConfig = loadGraphQLConfig({ schema });
+    const gqlConfig = loadGraphQLConfig({ schema, filePath: '' });
     const graphQLSchema = getSchema(gqlConfig.getDefault());
     expect(graphQLSchema).toBeInstanceOf(GraphQLSchema);
 
@@ -87,6 +87,7 @@ describe('schema', () => {
           schema: {
             [schemaUrl]: schemaOptions,
           },
+          filePath: '',
         });
         const error = getSchema(gqlConfig.getDefault()) as Error;
         expect(error).toBeInstanceOf(Error);
@@ -95,7 +96,7 @@ describe('schema', () => {
 
       // https://github.com/B2o5T/graphql-eslint/blob/master/docs/parser-options.md#schemaoptions
       it('with `parserOptions.schemaOptions`', () => {
-        const gqlConfig = loadGraphQLConfig({ schema: schemaUrl });
+        const gqlConfig = loadGraphQLConfig({ schema: schemaUrl, filePath: '' });
         const error = getSchema(gqlConfig.getDefault(), { schemaOptions }) as Error;
         expect(error).toBeInstanceOf(Error);
         expect(error.message).toMatch('"authorization":"Bearer Foo"');
@@ -105,7 +106,7 @@ describe('schema', () => {
 
   describe('schema loading', () => {
     it('should return Error', () => {
-      const gqlConfig = loadGraphQLConfig({ schema: 'not-exist.gql' });
+      const gqlConfig = loadGraphQLConfig({ schema: 'not-exist.gql', filePath: '' });
       const error = getSchema(gqlConfig.getDefault()) as Error;
       expect(error).toBeInstanceOf(Error);
       expect(error.message).toMatch(
@@ -115,9 +116,8 @@ describe('schema', () => {
   });
 
   it('should load the graphql-config rc file relative to the linted file', () => {
-    const schema = resolve(__dirname, 'mocks/using-config/schema.graphql');
     const gqlConfig = loadGraphQLConfig({
-      schema,
+      schema: resolve(__dirname, 'mocks/using-config/schema.graphql'),
       filePath: resolve(__dirname, 'mocks/using-config/test.graphql'),
     });