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
80 changes: 78 additions & 2 deletions src/main/java/graphql/schema/idl/SchemaTypeChecker.java
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@
import graphql.language.TypeExtensionDefinition;
import graphql.language.TypeName;
import graphql.language.UnionTypeDefinition;
import graphql.schema.idl.errors.InterfaceFieldArgumentRedefinitionError;
import graphql.schema.idl.errors.InterfaceFieldRedefinitionError;
import graphql.schema.idl.errors.MissingInterfaceFieldArgumentsError;
import graphql.schema.idl.errors.MissingInterfaceFieldError;
import graphql.schema.idl.errors.MissingInterfaceTypeError;
import graphql.schema.idl.errors.MissingScalarImplementationError;
import graphql.schema.idl.errors.MissingTypeError;
Expand Down Expand Up @@ -48,6 +52,8 @@ public List<GraphQLError> checkTypeRegistry(TypeDefinitionRegistry typeRegistry,
checkTypeExtensionsHaveCorrespondingType(errors, typeRegistry);
checkTypeExtensionsFieldRedefinition(errors, typeRegistry);

checkInterfacesAreImplemented(errors, typeRegistry);

checkSchemaInvariants(errors, typeRegistry);

checkScalarImplementationsArePresent(errors, typeRegistry, wiring);
Expand Down Expand Up @@ -136,7 +142,6 @@ private void checkForMissingTypes(List<GraphQLError> errors, TypeDefinitionRegis
});
}


private void checkScalarImplementationsArePresent(List<GraphQLError> errors, TypeDefinitionRegistry typeRegistry, RuntimeWiring wiring) {
typeRegistry.scalars().keySet().forEach(scalarName -> {
if (!wiring.getScalars().containsKey(scalarName)) {
Expand All @@ -145,6 +150,7 @@ private void checkScalarImplementationsArePresent(List<GraphQLError> errors, Typ
});
}


private void checkTypeResolversArePresent(List<GraphQLError> errors, TypeDefinitionRegistry typeRegistry, RuntimeWiring wiring) {

Consumer<TypeDefinition> checkForResolver = typeDef -> {
Expand All @@ -159,7 +165,6 @@ private void checkTypeResolversArePresent(List<GraphQLError> errors, TypeDefinit

}


private void checkFieldTypesPresent(TypeDefinitionRegistry typeRegistry, List<GraphQLError> errors, TypeDefinition typeDefinition, List<FieldDefinition> fields) {
List<Type> fieldTypes = fields.stream().map(FieldDefinition::getType).collect(Collectors.toList());
fieldTypes.forEach(checkTypeExists("field", typeRegistry, errors, typeDefinition));
Expand All @@ -175,6 +180,7 @@ private void checkFieldTypesPresent(TypeDefinitionRegistry typeRegistry, List<Gr
fieldInputValues.forEach(checkTypeExists("field input", typeRegistry, errors, typeDefinition));
}


private Consumer<Type> checkTypeExists(String typeOfType, TypeDefinitionRegistry typeRegistry, List<GraphQLError> errors, TypeDefinition typeDefinition) {
return t -> {
TypeName unwrapped = TypeInfo.typeInfo(t).getTypeName();
Expand All @@ -197,6 +203,76 @@ private Consumer<? super Type> checkInterfaceTypeExists(TypeDefinitionRegistry t
};
}

private void checkInterfacesAreImplemented(List<GraphQLError> errors, TypeDefinitionRegistry typeRegistry) {
Map<String, TypeDefinition> typesMap = typeRegistry.types();

// objects
List<ObjectTypeDefinition> objectTypes = filterTo(typesMap, ObjectTypeDefinition.class);
objectTypes.forEach(objectType -> {
List<Type> implementsTypes = objectType.getImplements();
implementsTypes.forEach(checkInterfaceIsImplemented("object", typeRegistry, errors, objectType));
});

Map<String, List<TypeExtensionDefinition>> typeExtensions = typeRegistry.typeExtensions();
typeExtensions.values().forEach(extList -> extList.forEach(typeExtension -> {
List<Type> implementsTypes = typeExtension.getImplements();
implementsTypes.forEach(checkInterfaceIsImplemented("extension", typeRegistry, errors, typeExtension));
}));
}

private Consumer<? super Type> checkInterfaceIsImplemented(String typeOfType, TypeDefinitionRegistry typeRegistry, List<GraphQLError> errors, ObjectTypeDefinition objectTypeDef) {
return t -> {
TypeInfo typeInfo = TypeInfo.typeInfo(t);
TypeName unwrapped = typeInfo.getTypeName();
Optional<TypeDefinition> type = typeRegistry.getType(unwrapped);
// previous checks handle the missing case and wrong type case
if (type.isPresent() && type.get() instanceof InterfaceTypeDefinition) {
InterfaceTypeDefinition interfaceTypeDef = (InterfaceTypeDefinition) type.get();

Map<String, FieldDefinition> objectFields = objectTypeDef.getFieldDefinitions().stream()
.collect(Collectors.toMap(
FieldDefinition::getName, Function.identity()
));

interfaceTypeDef.getFieldDefinitions().forEach(interfaceFieldDef -> {
FieldDefinition objectFieldDef = objectFields.get(interfaceFieldDef.getName());
if (objectFieldDef == null) {
errors.add(new MissingInterfaceFieldError(typeOfType, objectTypeDef, interfaceTypeDef, interfaceFieldDef));
} else {
String interfaceFieldType = AstPrinter.printAst(interfaceFieldDef.getType());
String objectFieldType = AstPrinter.printAst(objectFieldDef.getType());
if (!interfaceFieldType.equals(objectFieldType)) {
errors.add(new InterfaceFieldRedefinitionError(typeOfType, objectTypeDef, interfaceTypeDef, objectFieldDef, objectFieldType, interfaceFieldType));
}

// look at arguments
List<InputValueDefinition> objectArgs = objectFieldDef.getInputValueDefinitions();
List<InputValueDefinition> interfaceArgs = interfaceFieldDef.getInputValueDefinitions();
if (objectArgs.size() != interfaceArgs.size()) {
errors.add(new MissingInterfaceFieldArgumentsError(typeOfType, objectTypeDef, interfaceTypeDef, objectFieldDef));
} else {
checkArgumentConsistency(typeOfType, objectTypeDef, interfaceTypeDef, objectFieldDef, interfaceFieldDef, errors);
}
}
});
}
};
}

private void checkArgumentConsistency(String typeOfType, ObjectTypeDefinition objectTypeDef, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, FieldDefinition interfaceFieldDef, List<GraphQLError> errors) {
List<InputValueDefinition> objectArgs = objectFieldDef.getInputValueDefinitions();
List<InputValueDefinition> interfaceArgs = interfaceFieldDef.getInputValueDefinitions();
for (int i = 0; i < interfaceArgs.size(); i++) {
InputValueDefinition interfaceArg = interfaceArgs.get(i);
InputValueDefinition objectArg = objectArgs.get(i);
String interfaceArgStr = AstPrinter.printAst(interfaceArg);
String objectArgStr = AstPrinter.printAst(objectArg);
if (!interfaceArgStr.equals(objectArgStr)) {
errors.add(new InterfaceFieldArgumentRedefinitionError(typeOfType, objectTypeDef, interfaceTypeDef, objectFieldDef, objectArgStr, interfaceArgStr));
}
}
}

/*
A type can re-define a field if its actual the same type, but if they make 'fieldA : String' into
'fieldA : Int' then we cant handle that. Even 'fieldA : String' to 'fieldA: String!' is tough to handle
Expand Down
5 changes: 1 addition & 4 deletions src/main/java/graphql/schema/idl/errors/BaseError.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@ public ErrorType getErrorType() {

@Override
public String toString() {
return "BaseError{" +
"msg='" + getMessage() + '\'' +
", node=" + node +
'}';
return getMessage();
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package graphql.schema.idl.errors;

import graphql.language.FieldDefinition;
import graphql.language.InterfaceTypeDefinition;
import graphql.language.ObjectTypeDefinition;

import static java.lang.String.format;


public class InterfaceFieldArgumentRedefinitionError extends BaseError {
public InterfaceFieldArgumentRedefinitionError(String typeOfType, ObjectTypeDefinition objectTypeDef, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, String objectArgStr, String interfaceArgStr) {
super(objectTypeDef, format("The %s type '%s' %s has tried to redefine field '%s' arguments defined via interface '%s' %s from '%s' to '%s",
typeOfType, objectTypeDef.getName(), lineCol(objectTypeDef), objectFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef), interfaceArgStr, objectArgStr));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package graphql.schema.idl.errors;

import graphql.language.FieldDefinition;
import graphql.language.InterfaceTypeDefinition;
import graphql.language.ObjectTypeDefinition;

import static java.lang.String.format;

public class InterfaceFieldRedefinitionError extends BaseError {
public InterfaceFieldRedefinitionError(String typeOfType, ObjectTypeDefinition objectType, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, String objectFieldType, String interfaceFieldType) {
super(objectType, format("The %s type '%s' %s has tried to redefine field '%s' defined via interface '%s' %s from '%s' to '%s",
typeOfType, objectType.getName(), lineCol(objectType), objectFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef), interfaceFieldType, objectFieldType));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package graphql.schema.idl.errors;

import graphql.language.FieldDefinition;
import graphql.language.InterfaceTypeDefinition;
import graphql.language.ObjectTypeDefinition;

import static java.lang.String.format;

public class MissingInterfaceFieldArgumentsError extends BaseError {
public MissingInterfaceFieldArgumentsError(String typeOfType, ObjectTypeDefinition objectTypeDef, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef) {
super(objectTypeDef, format("The %s type '%s' %s field '%s' does not have the same number of arguments as specified via interface '%s' %s",
typeOfType, objectTypeDef.getName(), lineCol(objectTypeDef), objectFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef)));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package graphql.schema.idl.errors;

import graphql.language.FieldDefinition;
import graphql.language.InterfaceTypeDefinition;
import graphql.language.ObjectTypeDefinition;

import static java.lang.String.format;

public class MissingInterfaceFieldError extends BaseError {
public MissingInterfaceFieldError(String typeOfType, ObjectTypeDefinition objectType, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition interfaceFieldDef) {
super(objectType, format("The %s type '%s' %s does not have a field '%s' required via interface '%s' %s",
typeOfType, objectType.getName(), lineCol(objectType), interfaceFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef)));
}
}
7 changes: 5 additions & 2 deletions src/test/groovy/graphql/schema/idl/SchemaGeneratorTest.groovy
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ class SchemaGeneratorTest extends Specification {
def spec = """

interface Interface1 {
baseField : String
extraField1 : String
}

interface Interface2 {
Expand All @@ -356,10 +356,12 @@ class SchemaGeneratorTest extends Specification {
}

extend type BaseType implements Interface2 {
extraField1 : String
extraField2 : Int
}

extend type BaseType implements Interface3 {
extraField1 : String
extraField3 : ID
}

Expand All @@ -376,7 +378,7 @@ class SchemaGeneratorTest extends Specification {
# they will be de-duped since the effect is the same
#
extend type BaseType implements Interface1 {
baseField : String
extraField1 : String
}

schema {
Expand Down Expand Up @@ -448,6 +450,7 @@ class SchemaGeneratorTest extends Specification {
}

extend type Human implements Character {
name: String!
friends: [Character]
}

Expand Down
Loading