@graphql-eslint/eslint-plugin 3.16.0 → 3.16.1-alpha-20230226183026-b86ac84

package/cjs/rules/require-id-when-available.js

@@ -128,65 +128,83 @@ exports.rule = {
         // Can't access to node.parent in GraphQL AST.Node, so pass as argument
         parent, checkedFragmentSpreads = new Set()) {
             const rawType = (0, index_js_1.getBaseType)(type);
-            const isObjectType = rawType instanceof graphql_1.GraphQLObjectType;
-            const isInterfaceType = rawType instanceof graphql_1.GraphQLInterfaceType;
-            if (!isObjectType && !isInterfaceType) {
-                return;
+            if (rawType instanceof graphql_1.GraphQLObjectType || rawType instanceof graphql_1.GraphQLInterfaceType) {
+                checkFields(rawType);
             }
-            const fields = rawType.getFields();
-            const hasIdFieldInType = idNames.some(name => fields[name]);
-            if (!hasIdFieldInType) {
-                return;
-            }
-            function hasIdField({ selections }) {
-                return selections.some(selection => {
-                    if (selection.kind === graphql_1.Kind.FIELD) {
-                        if (selection.alias && idNames.includes(selection.alias.value)) {
-                            return true;
-                        }
-                        return idNames.includes(selection.name.value);
-                    }
+            else if (rawType instanceof graphql_1.GraphQLUnionType) {
+                for (const selection of node.selections) {
                     if (selection.kind === graphql_1.Kind.INLINE_FRAGMENT) {
-                        return hasIdField(selection.selectionSet);
-                    }
-                    if (selection.kind === graphql_1.Kind.FRAGMENT_SPREAD) {
-                        const [foundSpread] = siblings.getFragment(selection.name.value);
-                        if (foundSpread) {
-                            const fragmentSpread = foundSpread.document;
-                            checkedFragmentSpreads.add(fragmentSpread.name.value);
-                            return hasIdField(fragmentSpread.selectionSet);
+                        const types = rawType.getTypes();
+                        const t = types.find(t => t.name === selection.typeCondition.name.value);
+                        if (t) {
+                            checkFields(t);
                         }
                     }
-                    return false;
-                });
-            }
-            const hasId = hasIdField(node);
-            checkFragments(node);
-            if (hasId) {
-                return;
+                }
             }
-            const pluralSuffix = idNames.length > 1 ? 's' : '';
-            const fieldName = (0, utils_js_1.englishJoinWords)(idNames.map(name => `\`${(parent.alias || parent.name).value}.${name}\``));
-            const addition = checkedFragmentSpreads.size === 0
-                ? ''
-                : ` or add to used fragment${checkedFragmentSpreads.size > 1 ? 's' : ''} ${(0, utils_js_1.englishJoinWords)([...checkedFragmentSpreads].map(name => `\`${name}\``))}`;
-            const problem = {
-                loc,
-                messageId: RULE_ID,
-                data: {
-                    pluralSuffix,
-                    fieldName,
-                    addition,
-                },
-            };
-            // Don't provide suggestions for selections in fragments as fragment can be in a separate file
-            if ('type' in node) {
-                problem.suggest = idNames.map(idName => ({
-                    desc: `Add \`${idName}\` selection`,
-                    fix: fixer => fixer.insertTextBefore(node.selections[0], `${idName} `),
-                }));
+            function checkFields(rawType) {
+                const fields = rawType.getFields();
+                const hasIdFieldInType = idNames.some(name => fields[name]);
+                if (!hasIdFieldInType) {
+                    return;
+                }
+                function hasIdField({ selections }) {
+                    return selections.some(selection => {
+                        if (selection.kind === graphql_1.Kind.FIELD) {
+                            if (selection.alias && idNames.includes(selection.alias.value)) {
+                                return true;
+                            }
+                            return idNames.includes(selection.name.value);
+                        }
+                        if (selection.kind === graphql_1.Kind.INLINE_FRAGMENT) {
+                            return hasIdField(selection.selectionSet);
+                        }
+                        if (selection.kind === graphql_1.Kind.FRAGMENT_SPREAD) {
+                            const [foundSpread] = siblings.getFragment(selection.name.value);
+                            if (foundSpread) {
+                                const fragmentSpread = foundSpread.document;
+                                checkedFragmentSpreads.add(fragmentSpread.name.value);
+                                return hasIdField(fragmentSpread.selectionSet);
+                            }
+                        }
+                        return false;
+                    });
+                }
+                const hasId = hasIdField(node);
+                checkFragments(node);
+                if (hasId) {
+                    return;
+                }
+                const pluralSuffix = idNames.length > 1 ? 's' : '';
+                const fieldName = (0, utils_js_1.englishJoinWords)(idNames.map(name => `\`${(parent.alias || parent.name).value}.${name}\``));
+                const addition = checkedFragmentSpreads.size === 0
+                    ? ''
+                    : ` or add to used fragment${checkedFragmentSpreads.size > 1 ? 's' : ''} ${(0, utils_js_1.englishJoinWords)([...checkedFragmentSpreads].map(name => `\`${name}\``))}`;
+                const problem = {
+                    loc,
+                    messageId: RULE_ID,
+                    data: {
+                        pluralSuffix,
+                        fieldName,
+                        addition,
+                    },
+                };
+                // Don't provide suggestions for selections in fragments as fragment can be in a separate file
+                if ('type' in node) {
+                    problem.suggest = idNames.map(idName => ({
+                        desc: `Add \`${idName}\` selection`,
+                        fix: fixer => {
+                            let insertNode = node.selections[0];
+                            insertNode =
+                                insertNode.kind === graphql_1.Kind.INLINE_FRAGMENT
+                                    ? insertNode.selectionSet.selections[0]
+                                    : insertNode;
+                            return fixer.insertTextBefore(insertNode, `${idName} `);
+                        },
+                    }));
+                }
+                context.report(problem);
             }
-            context.report(problem);
         }
         return {
             [selector](node) {

package/esm/rules/require-id-when-available.js

@@ -1,5 +1,5 @@
 import { asArray } from '@graphql-tools/utils';
-import { GraphQLInterfaceType, GraphQLObjectType, Kind, TypeInfo, visit, visitWithTypeInfo, } from 'graphql';
+import { GraphQLInterfaceType, GraphQLObjectType, GraphQLUnionType, Kind, TypeInfo, visit, visitWithTypeInfo, } from 'graphql';
 import { getBaseType } from '../estree-converter/index.js';
 import { ARRAY_DEFAULT_OPTIONS, englishJoinWords, requireGraphQLSchemaFromContext, requireSiblingsOperations, } from '../utils.js';
 const RULE_ID = 'require-id-when-available';
@@ -125,65 +125,83 @@ export const rule = {
         // Can't access to node.parent in GraphQL AST.Node, so pass as argument
         parent, checkedFragmentSpreads = new Set()) {
             const rawType = getBaseType(type);
-            const isObjectType = rawType instanceof GraphQLObjectType;
-            const isInterfaceType = rawType instanceof GraphQLInterfaceType;
-            if (!isObjectType && !isInterfaceType) {
-                return;
+            if (rawType instanceof GraphQLObjectType || rawType instanceof GraphQLInterfaceType) {
+                checkFields(rawType);
             }
-            const fields = rawType.getFields();
-            const hasIdFieldInType = idNames.some(name => fields[name]);
-            if (!hasIdFieldInType) {
-                return;
-            }
-            function hasIdField({ selections }) {
-                return selections.some(selection => {
-                    if (selection.kind === Kind.FIELD) {
-                        if (selection.alias && idNames.includes(selection.alias.value)) {
-                            return true;
-                        }
-                        return idNames.includes(selection.name.value);
-                    }
+            else if (rawType instanceof GraphQLUnionType) {
+                for (const selection of node.selections) {
                     if (selection.kind === Kind.INLINE_FRAGMENT) {
-                        return hasIdField(selection.selectionSet);
-                    }
-                    if (selection.kind === Kind.FRAGMENT_SPREAD) {
-                        const [foundSpread] = siblings.getFragment(selection.name.value);
-                        if (foundSpread) {
-                            const fragmentSpread = foundSpread.document;
-                            checkedFragmentSpreads.add(fragmentSpread.name.value);
-                            return hasIdField(fragmentSpread.selectionSet);
+                        const types = rawType.getTypes();
+                        const t = types.find(t => t.name === selection.typeCondition.name.value);
+                        if (t) {
+                            checkFields(t);
                         }
                     }
-                    return false;
-                });
-            }
-            const hasId = hasIdField(node);
-            checkFragments(node);
-            if (hasId) {
-                return;
+                }
             }
-            const pluralSuffix = idNames.length > 1 ? 's' : '';
-            const fieldName = englishJoinWords(idNames.map(name => `\`${(parent.alias || parent.name).value}.${name}\``));
-            const addition = checkedFragmentSpreads.size === 0
-                ? ''
-                : ` or add to used fragment${checkedFragmentSpreads.size > 1 ? 's' : ''} ${englishJoinWords([...checkedFragmentSpreads].map(name => `\`${name}\``))}`;
-            const problem = {
-                loc,
-                messageId: RULE_ID,
-                data: {
-                    pluralSuffix,
-                    fieldName,
-                    addition,
-                },
-            };
-            // Don't provide suggestions for selections in fragments as fragment can be in a separate file
-            if ('type' in node) {
-                problem.suggest = idNames.map(idName => ({
-                    desc: `Add \`${idName}\` selection`,
-                    fix: fixer => fixer.insertTextBefore(node.selections[0], `${idName} `),
-                }));
+            function checkFields(rawType) {
+                const fields = rawType.getFields();
+                const hasIdFieldInType = idNames.some(name => fields[name]);
+                if (!hasIdFieldInType) {
+                    return;
+                }
+                function hasIdField({ selections }) {
+                    return selections.some(selection => {
+                        if (selection.kind === Kind.FIELD) {
+                            if (selection.alias && idNames.includes(selection.alias.value)) {
+                                return true;
+                            }
+                            return idNames.includes(selection.name.value);
+                        }
+                        if (selection.kind === Kind.INLINE_FRAGMENT) {
+                            return hasIdField(selection.selectionSet);
+                        }
+                        if (selection.kind === Kind.FRAGMENT_SPREAD) {
+                            const [foundSpread] = siblings.getFragment(selection.name.value);
+                            if (foundSpread) {
+                                const fragmentSpread = foundSpread.document;
+                                checkedFragmentSpreads.add(fragmentSpread.name.value);
+                                return hasIdField(fragmentSpread.selectionSet);
+                            }
+                        }
+                        return false;
+                    });
+                }
+                const hasId = hasIdField(node);
+                checkFragments(node);
+                if (hasId) {
+                    return;
+                }
+                const pluralSuffix = idNames.length > 1 ? 's' : '';
+                const fieldName = englishJoinWords(idNames.map(name => `\`${(parent.alias || parent.name).value}.${name}\``));
+                const addition = checkedFragmentSpreads.size === 0
+                    ? ''
+                    : ` or add to used fragment${checkedFragmentSpreads.size > 1 ? 's' : ''} ${englishJoinWords([...checkedFragmentSpreads].map(name => `\`${name}\``))}`;
+                const problem = {
+                    loc,
+                    messageId: RULE_ID,
+                    data: {
+                        pluralSuffix,
+                        fieldName,
+                        addition,
+                    },
+                };
+                // Don't provide suggestions for selections in fragments as fragment can be in a separate file
+                if ('type' in node) {
+                    problem.suggest = idNames.map(idName => ({
+                        desc: `Add \`${idName}\` selection`,
+                        fix: fixer => {
+                            let insertNode = node.selections[0];
+                            insertNode =
+                                insertNode.kind === Kind.INLINE_FRAGMENT
+                                    ? insertNode.selectionSet.selections[0]
+                                    : insertNode;
+                            return fixer.insertTextBefore(insertNode, `${idName} `);
+                        },
+                    }));
+                }
+                context.report(problem);
             }
-            context.report(problem);
         }
         return {
             [selector](node) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-eslint/eslint-plugin",
-  "version": "3.16.0",
+  "version": "3.16.1-alpha-20230226183026-b86ac84",
   "description": "GraphQL plugin for ESLint",
   "sideEffects": false,
   "peerDependencies": {