Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add option to avoid cycles #49

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add option to avoid cycles #49

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bea5750
chore(cycles): avoid cycles in queries
mariusaarsnes Nov 17, 2021
56f43f2
chore(cycles): make avoid cycles optional
mariusaarsnes Nov 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@ program
.option('--depthLimit [value]', 'query depth you want to limit(The default is 100)')
.option('--ext [value]', 'extension file to use', 'gql')
.option('-C, --includeDeprecatedFields [value]', 'Flag to include deprecated fields (The default is to exclude)')
.option('-C, --avoidCycles [value]', 'Flag to avoid cycles in the generated queries (The default is set to false)')
.parse(process.argv);

const {
schemaFilePath, destDirPath, depthLimit = 100, includeDeprecatedFields = false, ext: fileExtension,
schemaFilePath, destDirPath, depthLimit = 100, includeDeprecatedFields = false, ext: fileExtension, avoidCycles = false
} = program;
const typeDef = fs.readFileSync(schemaFilePath, 'utf-8');
const source = new Source(typeDef);
Expand Down Expand Up @@ -80,6 +81,7 @@ const getVarsToTypesStr = dict => Object.entries(dict)
* @param crossReferenceKeyList list of the cross reference
* @param curDepth current depth of field
* @param fromUnion adds additional depth for unions to avoid empty child
* @param parents a set of previous parent names used to avoid cycles
*/
const generateQuery = (
curName,
Expand All @@ -90,13 +92,19 @@ const generateQuery = (
crossReferenceKeyList = [], // [`${curParentName}To${curName}Key`]
curDepth = 1,
fromUnion = false,
parents = new Set(),
) => {
const field = gqlSchema.getType(curParentType).getFields()[curName];
const curTypeName = field.type.inspect().replace(/[[\]!]/g, '');
const curType = gqlSchema.getType(curTypeName);
let queryStr = '';
let childQuery = '';

/* Avoid cycles */
if (avoidCycles && parents.has(curName)) {
return {queryStr, argumentsDict}
}

if (curType.getFields) {
const crossReferenceKey = `${curParentName}To${curName}Key`;
if (crossReferenceKeyList.indexOf(crossReferenceKey) !== -1 || (fromUnion ? curDepth - 2 : curDepth) > depthLimit) return '';
Expand All @@ -110,8 +118,11 @@ const generateQuery = (
const fieldSchema = gqlSchema.getType(curType).getFields()[fieldName];
return includeDeprecatedFields || !fieldSchema.isDeprecated;
})
.map(cur => generateQuery(cur, curType, curName, argumentsDict, duplicateArgCounts,
crossReferenceKeyList, curDepth + 1, fromUnion).queryStr)
.map(cur =>
avoidCycles
? generateQuery(cur, curType, curName, argumentsDict, duplicateArgCounts, crossReferenceKeyList, curDepth + 1, fromUnion, new Set([...parents, curName])).queryStr
: generateQuery(cur, curType, curName, argumentsDict, duplicateArgCounts, crossReferenceKeyList, curDepth + 1, fromUnion).queryStr
)
.filter(cur => Boolean(cur))
.join('\n');
}
Expand Down Expand Up @@ -140,8 +151,11 @@ const generateQuery = (
const valueTypeName = types[i];
const valueType = gqlSchema.getType(valueTypeName);
const unionChildQuery = Object.keys(valueType.getFields())
.map(cur => generateQuery(cur, valueType, curName, argumentsDict, duplicateArgCounts,
crossReferenceKeyList, curDepth + 2, true).queryStr)
.map(cur =>
avoidCycles
? generateQuery(cur, valueType, curName, argumentsDict, duplicateArgCounts, crossReferenceKeyList, curDepth + 2, true, new Set([...parents, curName])).queryStr
: generateQuery(cur, valueType, curName, argumentsDict, duplicateArgCounts, crossReferenceKeyList, curDepth + 2, true).queryStr
)
.filter(cur => Boolean(cur))
.join('\n');

Expand Down