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

Add UniqueInputFieldNames validator #58

Merged
merged 2 commits into from
Feb 17, 2020
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
33 changes: 33 additions & 0 deletions gql/lib/src/validation/rules/unique_input_field_names.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import "package:gql/ast.dart";
import "package:gql/src/validation/validating_visitor.dart";
import "package:gql/src/validation/validator.dart";

class DuplicateInputFieldNameError extends ValidationError {
const DuplicateInputFieldNameError({
ObjectFieldNode node,
}) : super(
node: node,
);
}

class UniqueInputFieldNames extends ValidatingVisitor {
Map<String, NameNode> knownNames = {};

@override
List<ValidationError> visitObjectValueNode(ObjectValueNode node) {
knownNames.clear();
final List<ValidationError> errors = [];
node.fields.forEach((field) => errors.addAll(_visitObjectFieldNode(field)));
return errors;
}

List<ValidationError> _visitObjectFieldNode(ObjectFieldNode node) {
final fieldName = node.name.value;
if (knownNames.containsKey(fieldName)) {
return [DuplicateInputFieldNameError(node: node)];
} else {
knownNames[fieldName] = node.name;
}
return [];
}
}
6 changes: 5 additions & 1 deletion gql/lib/src/validation/validator.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import "package:gql/src/validation/rules/lone_schema_definition.dart";
import "package:gql/src/validation/rules/unique_directive_names.dart";
import "package:gql/src/validation/rules/unique_enum_value_names.dart";
import "package:gql/src/validation/rules/unique_field_definition_names.dart";
import "package:gql/src/validation/rules/unique_input_field_names.dart";
import "package:gql/src/validation/rules/unique_operation_types.dart";
import "package:gql/src/validation/rules/unique_type_names.dart";
import "package:gql/src/validation/validating_visitor.dart";
Expand Down Expand Up @@ -91,7 +92,8 @@ enum ValidationRule {
uniqueEnumValueNames,
loneSchemaDefinition,
uniqueOperationTypes,
uniqueTypeNames
uniqueTypeNames,
uniqueInputFieldNames
}

ValidatingVisitor _mapRule(ValidationRule rule) {
Expand All @@ -108,6 +110,8 @@ ValidatingVisitor _mapRule(ValidationRule rule) {
return UniqueOperationTypes();
case ValidationRule.uniqueTypeNames:
return UniqueTypeNames();
case ValidationRule.uniqueInputFieldNames:
return UniqueInputFieldNames();
default:
return null;
}
Expand Down
92 changes: 92 additions & 0 deletions gql/test/validation/unique_input_field_names_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
import "package:gql/src/validation/rules/unique_input_field_names.dart";
import "package:gql/src/validation/validator.dart";
import "package:test/test.dart";

import "./common.dart";

final validate = createValidator({
ValidationRule.uniqueInputFieldNames,
});

void main() {
group("Unique input field names", () {
test("errors on non-unique input field names", () {
expect(
validate(
"""
{
field(arg: { f1: "value", f1: "value" })
}
""",
),
contains(
errorOfType<DuplicateInputFieldNameError>(),
),
);
});
test("errors on multiple non-unique input field names", () {
expect(
validate(
"""
{
field(arg: { f1: "value", f1: "value", f1: "value" })
}
""",
),
containsAll(
<Matcher>[
errorOfType<DuplicateInputFieldNameError>(),
errorOfType<DuplicateInputFieldNameError>()
],
),
);
});

test("errors on nested non-unique input field names", () {
expect(
validate(
"""
{
field(arg: { f1: {f2: "value", f2: "value" }})
}
""",
),
contains(
errorOfType<DuplicateInputFieldNameError>(),
),
);
});

test("allows for nested input objects with similar fields", () {
expect(validate("""
{
field(arg: {
deep: {
deep: {
id: 1
}
id: 1
}
id: 1
})
}
"""), isEmpty);
});

test("allows for input objects with fields", () {
expect(validate("""
{
field(arg: { f: true })
}
"""), isEmpty);
});

test("allows for same input object within two args", () {
expect(validate("""
{
field(arg1: { f: true }, arg2: { f: true })
}
"""), isEmpty);
});
});
}