Skip to content
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.

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

Reuse groupBy in validation rules #3307

Merged
merged 1 commit into from
Oct 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions src/jsutils/groupBy.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
/**
* Groups array items into a Map, given a function to produce grouping key.
*/
export function groupBy<K, T>(
list: ReadonlyArray<T>,
keyFn: (item: T) => K,
): Map<K, ReadonlyArray<T>> {
const result = new Map<K, Array<T>>();
for (const item of list) {
const key = keyFn(item);
const group = result.get(key);
if (group === undefined) {
result.set(key, [item]);
} else {
group.push(item);
}
}
return result;
}
12 changes: 0 additions & 12 deletions src/validation/__tests__/UniqueArgumentNamesRule-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,6 @@ describe('Validate: Unique argument names', () => {
locations: [
{ line: 3, column: 15 },
{ line: 3, column: 30 },
],
},
{
message: 'There can be only one argument named "arg1".',
locations: [
{ line: 3, column: 15 },
{ line: 3, column: 45 },
],
},
Expand Down Expand Up @@ -152,12 +146,6 @@ describe('Validate: Unique argument names', () => {
locations: [
{ line: 3, column: 26 },
{ line: 3, column: 41 },
],
},
{
message: 'There can be only one argument named "arg1".',
locations: [
{ line: 3, column: 26 },
{ line: 3, column: 56 },
],
},
Expand Down
6 changes: 0 additions & 6 deletions src/validation/__tests__/UniqueVariableNamesRule-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,6 @@ describe('Validate: Unique variable names', () => {
locations: [
{ line: 2, column: 16 },
{ line: 2, column: 25 },
],
},
{
message: 'There can be only one variable named "$x".',
locations: [
{ line: 2, column: 16 },
{ line: 2, column: 34 },
],
},
Expand Down
19 changes: 2 additions & 17 deletions src/validation/rules/UniqueArgumentDefinitionNamesRule.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { groupBy } from '../../jsutils/groupBy';

import { GraphQLError } from '../../error/GraphQLError';

import type { ASTVisitor } from '../../language/visitor';
Expand Down Expand Up @@ -72,20 +74,3 @@ export function UniqueArgumentDefinitionNamesRule(
return false;
}
}

function groupBy<K, T>(
list: ReadonlyArray<T>,
keyFn: (item: T) => K,
): Map<K, Array<T>> {
const result = new Map<K, Array<T>>();
for (const item of list) {
const key = keyFn(item);
const group = result.get(key);
if (group === undefined) {
result.set(key, [item]);
} else {
group.push(item);
}
}
return result;
}
37 changes: 21 additions & 16 deletions src/validation/rules/UniqueArgumentNamesRule.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
import { groupBy } from '../../jsutils/groupBy';

import { GraphQLError } from '../../error/GraphQLError';

import type { ArgumentNode } from '../../language/ast';
import type { ASTVisitor } from '../../language/visitor';

import type { ASTValidationContext } from '../ValidationContext';
Expand All @@ -14,27 +18,28 @@ import type { ASTValidationContext } from '../ValidationContext';
export function UniqueArgumentNamesRule(
context: ASTValidationContext,
): ASTVisitor {
let knownArgNames = Object.create(null);
return {
Field() {
knownArgNames = Object.create(null);
},
Directive() {
knownArgNames = Object.create(null);
},
Argument(node) {
const argName = node.name.value;
if (knownArgNames[argName]) {
Field: checkArgUniqueness,
Directive: checkArgUniqueness,
};

function checkArgUniqueness(parentNode: {
arguments?: ReadonlyArray<ArgumentNode>;
}) {
// istanbul ignore next (See: 'https://github.com/graphql/graphql-js/issues/2203')
const argumentNodes = parentNode.arguments ?? [];

const seenArgs = groupBy(argumentNodes, (arg) => arg.name.value);

for (const [argName, argNodes] of seenArgs) {
if (argNodes.length > 1) {
context.reportError(
new GraphQLError(
`There can be only one argument named "${argName}".`,
[knownArgNames[argName], node.name],
argNodes.map((node) => node.name),
),
);
} else {
knownArgNames[argName] = node.name;
}
return false;
},
};
}
}
}
36 changes: 20 additions & 16 deletions src/validation/rules/UniqueVariableNamesRule.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { groupBy } from '../../jsutils/groupBy';

import { GraphQLError } from '../../error/GraphQLError';

import type { ASTVisitor } from '../../language/visitor';
import type { VariableDefinitionNode } from '../../language/ast';

import type { ASTValidationContext } from '../ValidationContext';

Expand All @@ -13,22 +14,25 @@ import type { ASTValidationContext } from '../ValidationContext';
export function UniqueVariableNamesRule(
context: ASTValidationContext,
): ASTVisitor {
let knownVariableNames = Object.create(null);
return {
OperationDefinition() {
knownVariableNames = Object.create(null);
},
VariableDefinition(node: VariableDefinitionNode) {
const variableName = node.variable.name.value;
if (knownVariableNames[variableName]) {
context.reportError(
new GraphQLError(
`There can be only one variable named "$${variableName}".`,
[knownVariableNames[variableName], node.variable.name],
),
);
} else {
knownVariableNames[variableName] = node.variable.name;
OperationDefinition(operationNode) {
// istanbul ignore next (See: 'https://github.com/graphql/graphql-js/issues/2203')
const variableDefinitions = operationNode.variableDefinitions ?? [];

const seenVariableDefinitions = groupBy(
variableDefinitions,
(node) => node.variable.name.value,
);

for (const [variableName, variableNodes] of seenVariableDefinitions) {
if (variableNodes.length > 1) {
context.reportError(
new GraphQLError(
`There can be only one variable named "$${variableName}".`,
variableNodes.map((node) => node.variable.name),
),
);
}
}
},
};
Expand Down