Skip to content
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
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
import graphql.schema.GraphQLImplementingType;
import graphql.schema.GraphQLInterfaceType;
import graphql.schema.GraphQLNamedOutputType;
import graphql.schema.GraphQLNonNull;
import graphql.schema.GraphQLObjectType;
import graphql.schema.GraphQLOutputType;
import graphql.schema.GraphQLType;
import graphql.schema.GraphQLUnionType;
import graphql.util.FpKit;

import java.util.HashMap;
import java.util.List;
Expand Down Expand Up @@ -104,32 +106,41 @@ private void checkFieldTypeCompatibility(GraphQLImplementingType implementingTyp
private void checkFieldArgumentEquivalence(GraphQLImplementingType implementingType, GraphQLInterfaceType interfaceType, SchemaValidationErrorCollector validationErrorCollector, GraphQLFieldDefinition interfaceFieldDef, GraphQLFieldDefinition objectFieldDef) {
List<GraphQLArgument> interfaceArgs = interfaceFieldDef.getArguments();
List<GraphQLArgument> objectArgs = objectFieldDef.getArguments();
if (interfaceArgs.size() != objectArgs.size()) {

if (interfaceArgs.size() > objectArgs.size()) {
validationErrorCollector.addError(
error(format("%s type '%s' does not implement interface '%s' because field '%s' has a different number of arguments",
TYPE_OF_MAP.get(implementingType.getClass()), implementingType.getName(), interfaceType.getName(), interfaceFieldDef.getName())));
} else {
for (int i = 0; i < interfaceArgs.size(); i++) {
GraphQLArgument interfaceArg = interfaceArgs.get(i);
GraphQLArgument objectArg = objectArgs.get(i);

String interfaceArgStr = makeArgStr(interfaceArg);
String objectArgStr = makeArgStr(objectArg);

boolean same = true;
if (!interfaceArgStr.equals(objectArgStr)) {
same = false;
}
if (!Objects.equals(interfaceArg.getDefaultValue(), objectArg.getDefaultValue())) {
same = false;
Map<String, GraphQLArgument> interfaceArgsByName = FpKit.getByName(interfaceArgs, GraphQLArgument::getName);

objectArgs.forEach(objectArg -> {
GraphQLArgument interfaceArg = interfaceArgsByName.get(objectArg.getName());

if (interfaceArg == null) {
if (objectArg.getType() instanceof GraphQLNonNull) {
validationErrorCollector.addError(
error(format("%s type '%s' field '%s' defines an additional non-optional argument '%s' which is not allowed because field is also defined in interface '%s'",
TYPE_OF_MAP.get(implementingType.getClass()), implementingType.getName(), objectFieldDef.getName(), objectArg.getName(), interfaceType.getName())));
}
} else {
String interfaceArgStr = makeArgStr(objectArg);
String objectArgStr = makeArgStr(interfaceArg);

boolean same = true;
if (!interfaceArgStr.equals(objectArgStr)) {
same = false;
}
if (!Objects.equals(objectArg.getDefaultValue(), interfaceArg.getDefaultValue())) {
same = false;
}
if (!same) {
validationErrorCollector.addError(
error(format("%s type '%s' does not implement interface '%s' because field '%s' argument '%s' is defined differently",
TYPE_OF_MAP.get(implementingType.getClass()), implementingType.getName(), interfaceType.getName(), interfaceFieldDef.getName(), objectArg.getName())));
}
}
if (!same) {
validationErrorCollector.addError(
error(format("%s type '%s' does not implement interface '%s' because field '%s' argument '%s' is defined differently",
TYPE_OF_MAP.get(implementingType.getClass()), implementingType.getName(), interfaceType.getName(), interfaceFieldDef.getName(), interfaceArg.getName())));
}

}
});
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@ package graphql.schema.validation

import graphql.TypeResolutionEnvironment
import graphql.schema.GraphQLInterfaceType
import graphql.schema.GraphQLNonNull
import graphql.schema.GraphQLObjectType
import graphql.schema.TypeResolver
import spock.lang.Specification

import java.util.stream.Collectors

import static SchemaValidationErrorType.ObjectDoesNotImplementItsInterfaces
import static graphql.Scalars.GraphQLBoolean
import static graphql.Scalars.GraphQLInt
Expand Down Expand Up @@ -317,4 +320,82 @@ class TypesImplementInterfacesTest extends Specification {
goodErrorCollector.getErrors().isEmpty()
}

def "type can declare extra optional field arguments"() {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should add also an SDL based test, because we are currently not always consistent.

@felipe-gdr felipe-gdr May 24, 2020 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are tests that cover that for the SDL already in graphql.schema.idl.SchemaTypeCheckerTest.

"test field arguments on object can contain additional optional arguments"

Currently, the SDL validation doesn't reproduce the error described in the ticket.

given:

GraphQLInterfaceType InterfaceType = newInterface()
.name("Interface")
.field(newFieldDefinition().name("argField").type(GraphQLString))
.build()

SchemaValidationErrorCollector errorCollector = new SchemaValidationErrorCollector()

GraphQLObjectType objType = GraphQLObjectType.newObject()
.name("Object")
.withInterface(InterfaceType)
.field(newFieldDefinition().name("argField").type(GraphQLString)
.argument(newArgument().name("arg1").type(GraphQLInt))
)
.build()

when:
new TypesImplementInterfaces().check(objType, errorCollector)

then:
def errors = errorCollector.getErrors()
errors.isEmpty()
}

def "type cannot declare extra non-null field arguments"() {
given:

GraphQLInterfaceType InterfaceType = newInterface()
.name("Interface")
.field(newFieldDefinition().name("argField").type(GraphQLString))
.build()

SchemaValidationErrorCollector errorCollector = new SchemaValidationErrorCollector()

GraphQLObjectType objType = GraphQLObjectType.newObject()
.name("Object")
.withInterface(InterfaceType)
.field(newFieldDefinition().name("argField").type(GraphQLString)
.argument(newArgument().name("arg1").type(nonNull(GraphQLInt)))
)
.build()

when:
new TypesImplementInterfaces().check(objType, errorCollector)

then:
def errors = errorCollector.getErrors()
errors.size() == 1
errors.iterator().next().description == "object type 'Object' field 'argField' defines an additional non-optional argument 'arg1' which is not allowed because field is also defined in interface 'Interface'"
}

def "type can change order of field arguments"() {
given:

GraphQLInterfaceType InterfaceType = newInterface()
.name("Interface")
.field(newFieldDefinition().name("argField1").type(GraphQLString))
.field(newFieldDefinition().name("argField2").type(GraphQLString))
.build()

SchemaValidationErrorCollector errorCollector = new SchemaValidationErrorCollector()

GraphQLObjectType objType = GraphQLObjectType.newObject()
.name("Object")
.withInterface(InterfaceType)
.field(newFieldDefinition().name("argField2").type(GraphQLString))
.field(newFieldDefinition().name("argField1").type(GraphQLString))
.build()

when:
new TypesImplementInterfaces().check(objType, errorCollector)

then:
def errors = errorCollector.getErrors()
errors.isEmpty()
}
}