Skip to content

Completed analysis of include and skip directives #106

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: dev
Choose a base branch
from
Open

Completed analysis of include and skip directives #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fc3d616
completed the analysis of includes and skip directives on objects and…
evanmcneely Aug 18, 2022
fddd78a
updated QueryParser flow chart
evanmcneely Aug 18, 2022
9d01f85
updated directiveCheck in complexity analysis to consider all directi…
evanmcneely Aug 20, 2022
f135be4
added a test for multiple directives on one field
evanmcneely Aug 20, 2022
cb261a4
updated tests for directives in complexity analysis to add differenti…
evanmcneely Aug 20, 2022
0ccd91e
refactored directive check in complexity analysis to simplyify code
evanmcneely Aug 20, 2022
9efe334
added a test for skip directive and other directives on the same field
evanmcneely Aug 20, 2022
3401795
updated comments on changes
evanmcneely Aug 20, 2022
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
124 changes: 65 additions & 59 deletions src/analysis/QueryParser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ import { FieldWeight, TypeWeightObject, Variables } from '../@types/buildTypeWei
* |-----> Selection Set Node <-------|
* | /
* | Selection Node
* | (Field, Inline fragment and fragment spread)
* | | | \
* | Field Node | fragmentCache
* | | |
* | (Field, Inline fragment, directives and fragment spread)
* | | | \ \
* | Field Node | \ \
* | | | directiveExcludeField fragmentCache
* |<--calculateCast |
* | |
* |<------------------|
Expand Down Expand Up @@ -148,79 +148,85 @@ class QueryParser {

/**
* Return true if:
* 1. there is no directive
* 2. there is a directive named inlcude and the value is true
* 3. there is a directive named skip and the value is false
* 2. there is a directive named inlcude and the value is false
* 3. there is a directive named skip and the value is true
*/
// THIS IS NOT CALLED ANYWEHERE. IN PROGRESS
private directiveCheck(directive: DirectiveNode): boolean {
if (directive?.arguments) {
// get the first argument
const argument = directive.arguments[0];
// ensure the argument name is 'if'
const argumentHasVariables =
argument.value.kind === Kind.VARIABLE && argument.name.value === 'if';
// access the value of the argument depending on whether it is passed as a variable or not
let directiveArgumentValue;
if (argument.value.kind === Kind.BOOLEAN) {
directiveArgumentValue = Boolean(argument.value.value);
} else if (argumentHasVariables) {
directiveArgumentValue = Boolean(this.variables[argument.value.name.value]);
private directiveExcludeField(directives: DirectiveNode[]): boolean {
let skipField = false;

directives.forEach((directive) => {
if (
directive?.arguments &&
(directive.name.value === 'include' || directive.name.value === 'skip') &&
directive.arguments[0].name.value === 'if'
) {
// only consider the first argument
const argument = directive.arguments[0];

const argumentHasVariables = argument.value.kind === Kind.VARIABLE;
let directiveArgumentValue;
if (argument.value.kind === Kind.BOOLEAN) {
directiveArgumentValue = Boolean(argument.value.value);
} else if (argumentHasVariables) {
directiveArgumentValue = Boolean(this.variables[argument.value.name.value]);
}

if (
(directive.name.value === 'include' && directiveArgumentValue === false) ||
(directive.name.value === 'skip' && directiveArgumentValue === true)
) {
skipField = true;
}
}
});

return (
(directive.name.value === 'include' && directiveArgumentValue === true) ||
(directive.name.value === 'skip' && directiveArgumentValue === false)
);
}
return true;
return skipField;
}

private selectionNode(node: SelectionNode, parentName: string): number {
let complexity = 0;
// TODO: complete implementation of directives include and skip
/**
* process this node only if:
* 1. there is no directive
* 1. there is no include or skip directive
* 2. there is a directive named inlcude and the value is true
* 3. there is a directive named skip and the value is false
*/
// const directive = node.directives;
// if (directive && this.directiveCheck(directive[0])) {
this.depth += 1;
if (this.depth > this.maxDepth) this.maxDepth = this.depth;
// the kind of a field node will either be field, fragment spread or inline fragment
if (node.kind === Kind.FIELD) {
complexity += this.fieldNode(node, parentName.toLowerCase());
} else if (node.kind === Kind.FRAGMENT_SPREAD) {
// add complexity and depth from fragment cache
const { complexity: fragComplexity, depth: fragDepth } =
this.fragmentCache[node.name.value];
complexity += fragComplexity;
this.depth += fragDepth;
if (node.directives && !this.directiveExcludeField([...node.directives])) {
this.depth += 1;
if (this.depth > this.maxDepth) this.maxDepth = this.depth;
this.depth -= fragDepth;
// the kind of a field node will either be field, fragment spread or inline fragment
if (node.kind === Kind.FIELD) {
complexity += this.fieldNode(node, parentName.toLowerCase());
} else if (node.kind === Kind.FRAGMENT_SPREAD) {
// add complexity and depth from fragment cache
const { complexity: fragComplexity, depth: fragDepth } =
this.fragmentCache[node.name.value];
complexity += fragComplexity;
this.depth += fragDepth;
if (this.depth > this.maxDepth) this.maxDepth = this.depth;
this.depth -= fragDepth;

// This is a leaf
// need to parse fragment definition at root and get the result here
} else if (node.kind === Kind.INLINE_FRAGMENT) {
const { typeCondition } = node;

// This is a leaf
// need to parse fragment definition at root and get the result here
} else if (node.kind === Kind.INLINE_FRAGMENT) {
const { typeCondition } = node;
// named type is the type from which inner fields should be take
// If the TypeCondition is omitted, an inline fragment is considered to be of the same type as the enclosing context
const namedType = typeCondition
? typeCondition.name.value.toLowerCase()
: parentName;

// named type is the type from which inner fields should be take
// If the TypeCondition is omitted, an inline fragment is considered to be of the same type as the enclosing context
const namedType = typeCondition ? typeCondition.name.value.toLowerCase() : parentName;
// subtract 1 before, and add one after, entering the fragment selection to negate the additional level of depth added
this.depth -= 1;
complexity += this.selectionSetNode(node.selectionSet, namedType);
this.depth += 1;
} else {
throw new Error(`ERROR: QueryParser.selectionNode: node type not supported`);
}

// TODO: Handle directives like @include and @skip
// subtract 1 before, and add one after, entering the fragment selection to negate the additional level of depth added
this.depth -= 1;
complexity += this.selectionSetNode(node.selectionSet, namedType);
this.depth += 1;
} else {
throw new Error(`ERROR: QueryParser.selectionNode: node type not supported`);
}

this.depth -= 1;
//* }
return complexity;
}

Expand Down
Loading