Skip to content

Commit ecb52d3

Browse files
committed
1764: Check if interface is implementing itself
fixes: #1764
1 parent 5dca065 commit ecb52d3

9 files changed

Lines changed: 85 additions & 42 deletions

‎src/main/java/graphql/schema/idl/ImplementingTypesChecker.java‎

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import graphql.schema.idl.errors.InterfaceFieldArgumentNotOptionalError;
1818
import graphql.schema.idl.errors.InterfaceFieldArgumentRedefinitionError;
1919
import graphql.schema.idl.errors.InterfaceFieldRedefinitionError;
20+
import graphql.schema.idl.errors.InterfaceImplementingItselfError;
2021
import graphql.schema.idl.errors.MissingInterfaceFieldArgumentsError;
2122
import graphql.schema.idl.errors.MissingInterfaceFieldError;
2223
import graphql.schema.idl.errors.MissingTransitiveInterfaceError;
@@ -79,13 +80,51 @@ private void checkImplementingType(
7980
String typeName) {
8081

8182
List<Type> implementsTypes = type.getImplements();
83+
8284
implementsTypes.forEach(checkInterfaceIsImplemented(typeName, typeRegistry, errors, type));
8385

84-
checkTransitiveInterfacesAreDeclared(typeName, typeRegistry, errors, type, implementsTypes);
86+
if (type instanceof InterfaceTypeDefinition) {
87+
final boolean implementItself = checkInterfaceDoesntImplementItself(typeName, typeRegistry, errors, (InterfaceTypeDefinition) type, implementsTypes);
88+
// Don't try to navigate the hierarchy if the interface implements itself, as this would result in an infinite loop
89+
if (!implementItself) {
90+
checkTransitiveInterfacesAreDeclared(typeName, typeRegistry, errors, type, implementsTypes);
91+
}
92+
} else {
93+
checkTransitiveInterfacesAreDeclared(typeName, typeRegistry, errors, type, implementsTypes);
94+
}
8595
}
8696

97+
private boolean checkInterfaceDoesntImplementItself(
98+
String typeOfType,
99+
TypeDefinitionRegistry typeRegistry,
100+
List<GraphQLError> errors,
101+
InterfaceTypeDefinition typeDefinition,
102+
List<Type> implementsInterfaces
103+
) {
104+
Set<String> implementsInterfacesNames = implementsInterfaces.stream()
105+
.map(t -> toInterfaceTypeDefinition(t, typeRegistry))
106+
.filter(Optional::isPresent)
107+
.map(Optional::get)
108+
.map(TypeDefinition::getName)
109+
.collect(Collectors.toSet());
110+
111+
String thisInterfaceName = typeDefinition.getName();
112+
113+
if (implementsInterfacesNames.contains(thisInterfaceName)) {
114+
errors.add(new InterfaceImplementingItselfError(typeOfType, typeDefinition));
115+
return true;
116+
}
117+
118+
return false;
119+
120+
}
87121

88-
private Consumer<? super Type> checkInterfaceIsImplemented(String typeOfType, TypeDefinitionRegistry typeRegistry, List<GraphQLError> errors, ImplementingTypeDefinition typeDefinition) {
122+
private Consumer<? super Type> checkInterfaceIsImplemented(
123+
String typeOfType,
124+
TypeDefinitionRegistry typeRegistry,
125+
List<GraphQLError> errors,
126+
ImplementingTypeDefinition typeDefinition
127+
) {
89128
return t -> {
90129
List<FieldDefinition> fieldDefinitions = typeDefinition.getFieldDefinitions();
91130

@@ -149,7 +188,14 @@ private void checkTransitiveInterfacesAreDeclared(
149188
}
150189
}
151190

152-
private void checkArgumentConsistency(String typeOfType, TypeDefinition objectTypeDef, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, FieldDefinition interfaceFieldDef, List<GraphQLError> errors) {
191+
private void checkArgumentConsistency(
192+
String typeOfType,
193+
ImplementingTypeDefinition objectTypeDef,
194+
InterfaceTypeDefinition interfaceTypeDef,
195+
FieldDefinition objectFieldDef,
196+
FieldDefinition interfaceFieldDef,
197+
List<GraphQLError> errors
198+
) {
153199
List<InputValueDefinition> objectArgs = objectFieldDef.getInputValueDefinitions();
154200
List<InputValueDefinition> interfaceArgs = interfaceFieldDef.getInputValueDefinitions();
155201
for (int i = 0; i < interfaceArgs.size(); i++) {
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
package graphql.schema.idl.errors;
22

33
import graphql.language.FieldDefinition;
4+
import graphql.language.ImplementingTypeDefinition;
45
import graphql.language.InterfaceTypeDefinition;
5-
import graphql.language.ObjectTypeDefinition;
6-
import graphql.language.TypeDefinition;
76

87
import static java.lang.String.format;
98

109
public class InterfaceFieldArgumentNotOptionalError extends BaseError {
11-
// TODO maybe duplicate this method, one for ObjectTypeDefinition and another for InterfaceTypeDefinition
12-
public InterfaceFieldArgumentNotOptionalError(String typeOfType, TypeDefinition objectTypeDef, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, String objectArgStr) {
13-
super(objectTypeDef, format("The %s type '%s' %s field '%s' defines an additional non-optional argument '%s' which is not allowed because field is also defined in interface '%s' %s.",
14-
typeOfType, objectTypeDef.getName(), lineCol(objectTypeDef), objectFieldDef.getName(), objectArgStr, interfaceTypeDef.getName(), lineCol(interfaceTypeDef)));
10+
public InterfaceFieldArgumentNotOptionalError(String typeOfType, ImplementingTypeDefinition typeDefinition, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, String objectArgStr) {
11+
super(typeDefinition, format("The %s type '%s' %s field '%s' defines an additional non-optional argument '%s' which is not allowed because field is also defined in interface '%s' %s.",
12+
typeOfType, typeDefinition.getName(), lineCol(typeDefinition), objectFieldDef.getName(), objectArgStr, interfaceTypeDef.getName(), lineCol(interfaceTypeDef)));
1513
}
1614
}
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
package graphql.schema.idl.errors;
22

33
import graphql.language.FieldDefinition;
4+
import graphql.language.ImplementingTypeDefinition;
45
import graphql.language.InterfaceTypeDefinition;
5-
import graphql.language.ObjectTypeDefinition;
6-
import graphql.language.TypeDefinition;
76

87
import static java.lang.String.format;
98

109

1110
public class InterfaceFieldArgumentRedefinitionError extends BaseError {
12-
// TODO maybe duplicate this method, one for ObjectTypeDefinition and another for InterfaceTypeDefinition
13-
public InterfaceFieldArgumentRedefinitionError(String typeOfType, TypeDefinition objectTypeDef, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, String objectArgStr, String interfaceArgStr) {
14-
super(objectTypeDef, format("The %s type '%s' %s has tried to redefine field '%s' arguments defined via interface '%s' %s from '%s' to '%s",
15-
typeOfType, objectTypeDef.getName(), lineCol(objectTypeDef), objectFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef), interfaceArgStr, objectArgStr));
11+
public InterfaceFieldArgumentRedefinitionError(String typeOfType, ImplementingTypeDefinition typeDefinition, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, String objectArgStr, String interfaceArgStr) {
12+
super(typeDefinition, format("The %s type '%s' %s has tried to redefine field '%s' arguments defined via interface '%s' %s from '%s' to '%s",
13+
typeOfType, typeDefinition.getName(), lineCol(typeDefinition), objectFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef), interfaceArgStr, objectArgStr));
1614
}
1715
}
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
package graphql.schema.idl.errors;
22

33
import graphql.language.FieldDefinition;
4+
import graphql.language.ImplementingTypeDefinition;
45
import graphql.language.InterfaceTypeDefinition;
5-
import graphql.language.ObjectTypeDefinition;
6-
import graphql.language.TypeDefinition;
76

87
import static java.lang.String.format;
98

109
public class InterfaceFieldRedefinitionError extends BaseError {
11-
// TODO maybe duplicate this method, one for ObjectTypeDefinition and another for InterfaceTypeDefinition
12-
public InterfaceFieldRedefinitionError(String typeOfType, TypeDefinition objectType, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, String objectFieldType, String interfaceFieldType) {
13-
super(objectType, format("The %s type '%s' %s has tried to redefine field '%s' defined via interface '%s' %s from '%s' to '%s'",
14-
typeOfType, objectType.getName(), lineCol(objectType), objectFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef), interfaceFieldType, objectFieldType));
10+
public InterfaceFieldRedefinitionError(String typeOfType, ImplementingTypeDefinition typeDefinition, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef, String objectFieldType, String interfaceFieldType) {
11+
super(typeDefinition, format("The %s type '%s' %s has tried to redefine field '%s' defined via interface '%s' %s from '%s' to '%s'",
12+
typeOfType, typeDefinition.getName(), lineCol(typeDefinition), objectFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef), interfaceFieldType, objectFieldType));
1513
}
1614
}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package graphql.schema.idl.errors;
2+
3+
import graphql.language.ImplementingTypeDefinition;
4+
5+
import static java.lang.String.format;
6+
7+
public class InterfaceImplementingItselfError extends BaseError {
8+
public InterfaceImplementingItselfError(String typeOfType, ImplementingTypeDefinition typeDefinition) {
9+
super(typeDefinition, format("The %s type '%s' %s cannot implement itself",
10+
typeOfType, typeDefinition.getName(), lineCol(typeDefinition)));
11+
}
12+
}
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
package graphql.schema.idl.errors;
22

33
import graphql.language.FieldDefinition;
4+
import graphql.language.ImplementingTypeDefinition;
45
import graphql.language.InterfaceTypeDefinition;
5-
import graphql.language.ObjectTypeDefinition;
6-
import graphql.language.TypeDefinition;
76

87
import static java.lang.String.format;
98

109
public class MissingInterfaceFieldArgumentsError extends BaseError {
11-
// TODO maybe duplicate this method, one for ObjectTypeDefinition and another for InterfaceTypeDefinition
12-
public MissingInterfaceFieldArgumentsError(String typeOfType, TypeDefinition objectTypeDef, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef) {
13-
super(objectTypeDef, format("The %s type '%s' %s field '%s' does not have the same number of arguments as specified via interface '%s' %s",
14-
typeOfType, objectTypeDef.getName(), lineCol(objectTypeDef), objectFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef)));
10+
public MissingInterfaceFieldArgumentsError(String typeOfType, ImplementingTypeDefinition typeDefinition, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition objectFieldDef) {
11+
super(typeDefinition, format("The %s type '%s' %s field '%s' does not have the same number of arguments as specified via interface '%s' %s",
12+
typeOfType, typeDefinition.getName(), lineCol(typeDefinition), objectFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef)));
1513
}
1614
}

‎src/main/java/graphql/schema/idl/errors/MissingInterfaceFieldError.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
package graphql.schema.idl.errors;
22

33
import graphql.language.FieldDefinition;
4+
import graphql.language.ImplementingTypeDefinition;
45
import graphql.language.InterfaceTypeDefinition;
5-
import graphql.language.ObjectTypeDefinition;
6-
import graphql.language.TypeDefinition;
76

87
import static java.lang.String.format;
98

109
public class MissingInterfaceFieldError extends BaseError {
11-
// TODO maybe duplicate this method, one for ObjectTypeDefinition and another for InterfaceTypeDefinition
12-
public MissingInterfaceFieldError(String typeOfType, TypeDefinition objectType, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition interfaceFieldDef) {
10+
public MissingInterfaceFieldError(String typeOfType, ImplementingTypeDefinition objectType, InterfaceTypeDefinition interfaceTypeDef, FieldDefinition interfaceFieldDef) {
1311
super(objectType, format("The %s type '%s' %s does not have a field '%s' required via interface '%s' %s",
1412
typeOfType, objectType.getName(), lineCol(objectType), interfaceFieldDef.getName(), interfaceTypeDef.getName(), lineCol(interfaceTypeDef)));
1513
}
Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
package graphql.schema.idl.errors;
22

3-
import graphql.language.InterfaceTypeDefinition;
4-
import graphql.language.TypeDefinition;
3+
import graphql.language.ImplementingTypeDefinition;
54

65
import java.util.Collection;
7-
import java.util.Set;
86

97
import static java.lang.String.format;
108

119
public class MissingTransitiveInterfaceError extends BaseError {
12-
// TODO maybe duplicate this method, one for ObjectTypeDefinition and another for InterfaceTypeDefinition
13-
public MissingTransitiveInterfaceError(String typeOfType, TypeDefinition objectType, Collection<String> missingInterfaces) {
14-
super(objectType, format("The %s type '%s' %s does not implement the following transitive interfaces: %s",
15-
typeOfType, objectType.getName(), lineCol(objectType), missingInterfaces));
10+
public MissingTransitiveInterfaceError(String typeOfType, ImplementingTypeDefinition typeDefinition, Collection<String> missingInterfaces) {
11+
super(typeDefinition, format("The %s type '%s' %s does not implement the following transitive interfaces: %s",
12+
typeOfType, typeDefinition.getName(), lineCol(typeDefinition), missingInterfaces));
1613
}
1714
}

‎src/test/groovy/graphql/InterfacesImplementingInterfacesTest.groovy‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ package graphql
44
import spock.lang.Specification
55

66
class InterfacesImplementingInterfacesTest extends Specification {
7-
8-
// TODO: maybe parameterized this test
97
def 'Simple interface implementing interface'() {
108
when:
119
TestUtil.schema("""
@@ -193,8 +191,8 @@ class InterfacesImplementingInterfacesTest extends Specification {
193191

194192

195193
then:
196-
// TODO: Assert error message
197-
thrown(AssertionError)
194+
def error = thrown(AssertionError)
195+
error.getMessage() ==~ ".*The interface type 'Node' .* cannot implement itself, The interface type 'Named' .* cannot implement itself.*";
198196
}
199197

200198
def 'When interface extension implements interface and declares required field, then parsing is successful'() {

0 commit comments

Comments
 (0)