fix false positive case in possible-type-extension rule when schema… (#857)

Author: dimaMachina

.changeset/tidy-kangaroos-sell.md

@@ -0,0 +1,5 @@
+---
+'@graphql-eslint/eslint-plugin': minor
+---
+
+fix false positive case in `possible-type-extension` rule when schema is separate into multiple files

.eslintrc.js

@@ -52,7 +52,7 @@ module.exports = {
       },
     },
     {
-      files: ['**/tests/mocks/*.{ts,js}'],
+      files: ['**/tests/mocks/**/*.{ts,js}'],
       rules: {
         '@typescript-eslint/no-unused-vars': 'off',
       },

README.md

@@ -42,7 +42,7 @@ npm install --save-dev @graphql-eslint/eslint-plugin
 
 > Make sure you have `graphql` dependency in your project.
 
-### Configuration
+## Configuration
 
 To get started, define an override in your ESLint config to apply this plugin to `.graphql` files. Add the [rules](docs/README.md) you want applied.
 
@@ -65,7 +65,7 @@ To get started, define an override in your ESLint config to apply this plugin to
 
 If your GraphQL definitions are defined only in `.graphql` files, and you're only using rules that apply to individual files, you should be good to go 👍. If you would like use a remote schema or use rules that apply across the entire collection of definitions at once, see [here](#using-a-remote-schema-or-rules-with-constraints-that-span-the-entire-schema).
 
-#### Tell ESLint to apply this plugin to GraphQL definitions defined in code files
+### Apply this plugin to GraphQL definitions defined in code files
 
 If you are defining GraphQL schema or GraphQL operations in code files, you'll want to define an additional override to extend the functionality of this plugin to the schema and operations in those files.
 
@@ -90,7 +90,7 @@ If you are defining GraphQL schema or GraphQL operations in code files, you'll w
 
 Under the hood, specifying the `@graphql-eslint/graphql` processor for code files will cause `graphql-eslint/graphql` to extract the schema and operation definitions from these files into virtual GraphQL documents with `.graphql` extensions. This will allow the overrides you've defined for `.graphql` files, via `"files": ["*.graphql"]`, to get applied to the definitions defined in your code files.
 
-#### Using a remote schema or rules with constraints that span the entire schema
+### Extended linting rules with GraphQL Schema
 
 Some rules require an understanding of the entire schema at once. For example, [no-unreachable-types](https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/no-unreachable-types.md#no-unreachable-types) checks that all types are reachable by root-level fields.
 
@@ -120,7 +120,7 @@ The parser allows you to specify a json file / graphql files(s) / url / raw stri
 
 > Some rules require type information to operate, it's marked in the docs for each rule!
 
-#### Extended linting rules with siblings operations
+### Extended linting rules with siblings operations
 
 While implementing this tool, we had to find solutions for a better integration of the GraphQL ecosystem and ESLint core.
 
@@ -180,7 +180,7 @@ You can find a list of [ESLint directives here](https://eslint.org/docs/2.13.1/u
 
 You can find a complete list of [all available rules here](docs/README.md).
 
-## Deprecated Rules
+### Deprecated Rules
 
 See [docs/deprecated-rules.md](docs/deprecated-rules.md).
 
@@ -201,7 +201,7 @@ See [docs/deprecated-rules.md](docs/deprecated-rules.md).
 
 > If you are in a monorepo project, you probably need both sets of rules.
 
-## Config usage
+### Config usage
 
 For example, to enable the `schema-recommended` config, enable it in your `.eslintrc` file with the `extends` option:
 

docs/rules/possible-type-extension.md

@@ -2,7 +2,7 @@
 
 - Category: `Schema`
 - Rule name: `@graphql-eslint/possible-type-extension`
-- Requires GraphQL Schema: `false` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
+- Requires GraphQL Schema: `true` [ℹ️](../../README.md#extended-linting-rules-with-graphql-schema)
 - Requires GraphQL Operations: `false` [ℹ️](../../README.md#extended-linting-rules-with-siblings-operations)
 
 A type extension is only valid if the type is defined and has the same kind.

packages/plugin/package.json

@@ -38,6 +38,7 @@
     "@graphql-tools/code-file-loader": "7.2.3",
     "@graphql-tools/graphql-tag-pluck": "7.1.4",
     "@graphql-tools/utils": "8.5.5",
+    "chalk": "4.1.2",
     "graphql-config": "4.1.0",
     "graphql-depth-limit": "1.1.0",
     "lodash.lowercase": "4.3.0"

packages/plugin/src/graphql-config.ts

@@ -2,13 +2,13 @@ import { GraphQLConfig, GraphQLExtensionDeclaration, loadConfigSync, SchemaPoint
 import { CodeFileLoader } from '@graphql-tools/code-file-loader';
 import { ParserOptions } from './types';
 
-let graphqlConfig: GraphQLConfig;
+let graphQLConfig: GraphQLConfig;
 
-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) {
-    return graphqlConfig;
+  if (process.env.NODE_ENV !== 'test' && graphQLConfig) {
+    return graphQLConfig;
   }
 
   const onDiskConfig = options.skipGraphQLConfig
@@ -19,25 +19,27 @@ export function loadGraphqlConfig(options: ParserOptions): GraphQLConfig {
         extensions: [addCodeFileLoaderExtension],
       });
 
-  graphqlConfig =
+  const configOptions = options.projects
+    ? { projects: options.projects }
+    : {
+        schema: (options.schema || '') as SchemaPointer, // if `schema` is `undefined` will throw error `Project 'default' not found`
+        documents: options.documents || options.operations,
+        extensions: options.extensions,
+        include: options.include,
+        exclude: options.exclude,
+      };
+
+  graphQLConfig =
     onDiskConfig ||
     new GraphQLConfig(
       {
-        config: options.projects
-          ? { projects: options.projects }
-          : {
-              schema: (options.schema || '') as SchemaPointer, // if `schema` is `undefined` will throw error `Project 'default' not found`
-              documents: options.documents || options.operations,
-              extensions: options.extensions,
-              include: options.include,
-              exclude: options.exclude,
-            },
+        config: configOptions,
         filepath: 'virtual-config',
       },
       [addCodeFileLoaderExtension]
     );
 
-  return graphqlConfig;
+  return graphQLConfig;
 }
 
 const addCodeFileLoaderExtension: GraphQLExtensionDeclaration = api => {

packages/plugin/src/parser.ts

@@ -6,15 +6,15 @@ import { GraphQLESLintParseResult, ParserOptions, ParserServices } from './types
 import { extractTokens } from './utils';
 import { getSchema } from './schema';
 import { getSiblingOperations } from './sibling-operations';
-import { loadGraphqlConfig } from './graphql-config';
+import { loadGraphQLConfig } from './graphql-config';
 import { getReachableTypes, getUsedFields } from './graphql-ast';
 
 export function parse(code: string, options?: ParserOptions): Linter.ESLintParseResult['ast'] {
   return parseForESLint(code, options).ast;
 }
 
 export function parseForESLint(code: string, options: ParserOptions = {}): GraphQLESLintParseResult {
-  const gqlConfig = loadGraphqlConfig(options);
+  const gqlConfig = loadGraphQLConfig(options);
   const schema = getSchema(options, gqlConfig);
   const parserServices: ParserServices = {
     hasTypeInfo: schema !== null,
@@ -49,21 +49,18 @@ export function parseForESLint(code: string, options: ParserOptions = {}): Graph
       },
     };
   } catch (e) {
+    e.message = `[graphql-eslint] ${e.message}`;
     // In case of GraphQL parser error, we report it to ESLint as a parser error that matches the requirements
     // of ESLint. This will make sure to display it correctly in IDEs and lint results.
     if (e instanceof GraphQLError) {
       const eslintError = {
         index: e.positions[0],
         lineNumber: e.locations[0].line,
         column: e.locations[0].column,
-        message: `[graphql-eslint]: ${e.message}`,
+        message: e.message,
       };
-
       throw eslintError;
     }
-
-    e.message = `[graphql-eslint]: ${e.message}`;
-
     throw e;
   }
 }

packages/plugin/src/processors/code-files.ts

@@ -1,5 +1,6 @@
 import { Linter } from 'eslint';
 import { parseCode } from '@graphql-tools/graphql-tag-pluck';
+import { logger } from '../utils';
 
 const RELEVANT_KEYWORDS = ['gql', 'graphql', '/* GraphQL */'];
 
@@ -45,8 +46,7 @@ export function createGraphqlProcessor(): Linter.Processor {
             return blocks;
           }
         } catch (e) {
-          // eslint-disable-next-line no-console
-          console.warn(`[graphql-eslint/processor]: Unable to process file "${filename}": `, e);
+          logger.warn(`Unable to process file "${filename}"`, e);
         }
       }
 

packages/plugin/src/rules/graphql-js-validation.ts

@@ -1,7 +1,6 @@
 import { AST } from 'eslint';
 import {
   Kind,
-  ASTNode,
   TypeInfo,
   DocumentNode,
   GraphQLSchema,
@@ -14,13 +13,11 @@ import {
 } from 'graphql';
 import { validateSDL } from 'graphql/validation/validate';
 import { GraphQLESLintRule, GraphQLESLintRuleContext } from '../types';
-import { getLocation, requireGraphQLSchemaFromContext, requireSiblingsOperations } from '../utils';
-import { GraphQLESTreeNode } from '../estree-parser';
+import { getLocation, requireGraphQLSchemaFromContext, requireSiblingsOperations, logger } from '../utils';
 
 function validateDocument(
-  sourceNode: GraphQLESTreeNode<ASTNode>,
   context: GraphQLESLintRuleContext,
-  schema: GraphQLSchema | null,
+  schema: GraphQLSchema | null = null,
   documentNode: DocumentNode,
   rule: ValidationRule
 ): void {
@@ -58,7 +55,8 @@ function validateDocument(
     }
   } catch (e) {
     context.report({
-      node: sourceNode,
+      // Report on first character
+      loc: { column: 0, line: 1 },
       message: e.message,
     });
   }
@@ -167,21 +165,22 @@ const validationToRule = (
         },
       },
       create(context) {
+        if (!ruleFn) {
+          logger.warn(
+            `You rule "${ruleId}" depends on a GraphQL validation rule "${ruleName}" but it's not available in the "graphql-js" version you are using. Skipping...`
+          );
+          return {};
+        }
+
         return {
           Document(node) {
-            if (!ruleFn) {
-              // eslint-disable-next-line no-console
-              console.warn(
-                `You rule "${ruleId}" depends on a GraphQL validation rule "${ruleName}" but it's not available in the "graphql-js" version you are using. Skipping...`
-              );
-              return;
-            }
             const schema = docs.requiresSchema ? requireGraphQLSchemaFromContext(ruleId, context) : null;
+
             const documentNode = getDocumentNode
               ? getDocumentNode({ ruleId, context, schema, node: node.rawNode() })
               : node.rawNode();
 
-            validateDocument(node, context, schema, documentNode, ruleFn);
+            validateDocument(context, schema, documentNode, ruleFn);
           },
         };
       },
@@ -376,6 +375,7 @@ export const GRAPHQL_JS_VALIDATIONS: Record<string, GraphQLESLintRule> = Object.
     category: 'Schema',
     description: `A type extension is only valid if the type is defined and has the same kind.`,
     recommended: false, // TODO: enable after https://github.com/dotansimha/graphql-eslint/issues/787 will be fixed
+    requiresSchema: true,
   }),
   validationToRule('provided-required-arguments', 'ProvidedRequiredArguments', {
     category: ['Schema', 'Operations'],

packages/plugin/src/rules/selection-set-depth.ts

@@ -2,17 +2,19 @@ import { GraphQLESLintRule } from '../types';
 import depthLimit from 'graphql-depth-limit';
 import { DocumentNode, FragmentDefinitionNode, GraphQLError, Kind, OperationDefinitionNode } from 'graphql';
 import { GraphQLESTreeNode } from '../estree-parser';
-import { getLocation, requireSiblingsOperations } from '../utils';
+import { getLocation, logger, requireSiblingsOperations } from '../utils';
 import { SiblingOperations } from '../sibling-operations';
 
 type SelectionSetDepthRuleConfig = { maxDepth: number; ignore?: string[] };
 
+const RULE_ID = 'selection-set-depth';
+
 const rule: GraphQLESLintRule<[SelectionSetDepthRuleConfig]> = {
   meta: {
     docs: {
       category: 'Operations',
       description: `Limit the complexity of the GraphQL operations solely by their depth. Based on [graphql-depth-limit](https://github.com/stems/graphql-depth-limit).`,
-      url: 'https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/selection-set-depth.md',
+      url: `https://github.com/dotansimha/graphql-eslint/blob/master/docs/rules/${RULE_ID}.md`,
       requiresSiblings: true,
       examples: [
         {
@@ -87,11 +89,10 @@ const rule: GraphQLESLintRule<[SelectionSetDepthRuleConfig]> = {
     let siblings: SiblingOperations | null = null;
 
     try {
-      siblings = requireSiblingsOperations('selection-set-depth', context);
+      siblings = requireSiblingsOperations(RULE_ID, context);
     } catch (e) {
-      // eslint-disable-next-line no-console
-      console.warn(
-        `Rule "selection-set-depth" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`
+      logger.warn(
+        `Rule "${RULE_ID}" works best with siblings operations loaded. For more info: http://bit.ly/graphql-eslint-operations`
       );
     }
 
@@ -121,9 +122,8 @@ const rule: GraphQLESLintRule<[SelectionSetDepthRuleConfig]> = {
             },
           });
         } catch (e) {
-          // eslint-disable-next-line no-console
-          console.warn(
-            `Rule "selection-set-depth" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`,
+          logger.warn(
+            `Rule "${RULE_ID}" check failed due to a missing siblings operations. For more info: http://bit.ly/graphql-eslint-operations`,
             e
           );
         }