Skip to content

Allow implementing field arguments to use different defaults #4491

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.

Sign up for GitHub

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

Open
goutamadwant wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow implementing field arguments to use different defaults #4491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 2 additions & 5 deletions src/main/java/graphql/schema/idl/ImplementingTypesChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,13 +185,10 @@ private void checkArgumentConsistency(
InputValueDefinition objectArg = objectArgs.get(interfaceEntries.getKey());
if (objectArg == null) {
errors.add(new MissingInterfaceFieldArgumentsError(typeOfType, objectTypeDef, interfaceTypeDef, objectFieldDef));
} else {
// we need to remove the not relevant applied directives on the argument definitions to compare
} else if (!AstPrinter.printAstCompact(interfaceArg.getType()).equals(AstPrinter.printAstCompact(objectArg.getType()))) {
String interfaceArgStr = AstPrinter.printAstCompact(interfaceArg.transform(builder -> builder.directives(emptyList())));
String objectArgStr = AstPrinter.printAstCompact(objectArg.transform(builder -> builder.directives(emptyList())));
if (!interfaceArgStr.equals(objectArgStr)) {
errors.add(new InterfaceFieldArgumentRedefinitionError(typeOfType, objectTypeDef, interfaceTypeDef, objectFieldDef, objectArgStr, interfaceArgStr));
}
errors.add(new InterfaceFieldArgumentRedefinitionError(typeOfType, objectTypeDef, interfaceTypeDef, objectFieldDef, objectArgStr, interfaceArgStr));
}
}

Expand Down
25 changes: 1 addition & 24 deletions src/main/java/graphql/schema/validation/TypesImplementInterfaces.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
package graphql.schema.validation;

import graphql.GraphQLContext;
import graphql.Internal;
import graphql.execution.ValuesResolver;
import graphql.language.Value;
import graphql.schema.GraphQLArgument;
import graphql.schema.GraphQLFieldDefinition;
import graphql.schema.GraphQLImplementingType;
Expand All @@ -21,13 +18,10 @@

import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Objects;
import java.util.stream.Collectors;

import static graphql.collect.ImmutableKit.map;
import static graphql.language.AstPrinter.printAst;
import static graphql.schema.GraphQLTypeUtil.isList;
import static graphql.schema.GraphQLTypeUtil.isNonNull;
import static graphql.schema.GraphQLTypeUtil.simplePrint;
Expand Down Expand Up @@ -145,23 +139,7 @@ private void checkFieldArgumentEquivalence(GraphQLImplementingType implementingT
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 (objectArg.hasSetDefaultValue() && interfaceArg.hasSetDefaultValue()) {
Value<?> objectDefaultValue = ValuesResolver.valueToLiteral(objectArg.getArgumentDefaultValue(), objectArg.getType(), GraphQLContext.getDefault(), Locale.getDefault());
Value<?> interfaceDefaultValue = ValuesResolver.valueToLiteral(interfaceArg.getArgumentDefaultValue(), interfaceArg.getType(), GraphQLContext.getDefault(), Locale.getDefault());
if (!Objects.equals(printAst(objectDefaultValue), printAst(interfaceDefaultValue))) {
same = false;
}
} else if (objectArg.hasSetDefaultValue() || interfaceArg.hasSetDefaultValue()) {
same = false;
}
if (!same) {
if (!makeArgStr(objectArg).equals(makeArgStr(interfaceArg))) {
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())));
Expand All @@ -172,7 +150,6 @@ private void checkFieldArgumentEquivalence(GraphQLImplementingType implementingT
}

private String makeArgStr(GraphQLArgument argument) {
// we don't do default value checking because toString of getDefaultValue is not guaranteed to be stable
return argument.getName() +
":" +
simplePrint(argument.getType());
Expand Down
50 changes: 44 additions & 6 deletions src/test/groovy/graphql/InterfacesImplementingInterfacesTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,47 @@ import static graphql.schema.GraphQLInterfaceType.newInterface
import static graphql.schema.GraphQLObjectType.newObject

class InterfacesImplementingInterfacesTest extends Specification {
def 'Execution uses the implementing field argument default'() {
given:
def registry = new SchemaParser().parse('''
type Query { account: Account }
interface Account { memberOf(limit: Int! = 100): Int }
type Host implements Account { memberOf(limit: Int! = 150): Int }
''')
def wiring = RuntimeWiring.newRuntimeWiring()
.type('Query', { typeWiring -> typeWiring.dataFetcher('account', { [:] }) })
.type('Account', { typeWiring -> typeWiring.typeResolver({ env -> env.schema.getObjectType('Host') }) })
.type('Host', { typeWiring -> typeWiring.dataFetcher('memberOf', { env -> env.getArgument('limit') }) })
.build()
def schema = new SchemaGenerator().makeExecutableSchema(registry, wiring)

when:
def result = GraphQL.newGraphQL(schema).build().execute('{ account { memberOf } }')

then:
!result.errors
result.data == [account: [memberOf: 150]]
}

def 'Implementing field arguments may have different default values'() {
when:
parseSchema("""
type Query { account: Account }
interface Account { memberOf(limit: Int! $interfaceDefault): [String] }
$implementingType Host implements Account { memberOf(limit: Int! $implementingDefault): [String] }
""")

then:
noExceptionThrown()

where:
implementingType | interfaceDefault | implementingDefault
'type' | '= 100' | '= 150'
'interface' | '= 100' | '= 150'
'type' | '= 100' | ''
'type' | '' | '= 150'
}

def 'Simple interface implementing interface'() {
when:
def schema = """
Expand Down Expand Up @@ -780,10 +821,9 @@ class InterfacesImplementingInterfacesTest extends Specification {

then:
def error = thrown(SchemaProblem)
error.errors.size() == 4
error.errors.size() == 3

assertErrorMessage(error, "The interface extension type 'BaseInterface' [@n:n] field 'fieldA' does not have the same number of arguments as specified via interface 'InterfaceType' [@n:n]")
assertErrorMessage(error, "The interface extension type 'BaseInterface' [@n:n] has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType' [@n:n] from 'arg1:String =\"defaultVal\"' to 'arg1:String =\"defaultValX\"")
assertErrorMessage(error, "The interface extension type 'BaseInterface' [@n:n] has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType' [@n:n] from 'arg2:String' to 'arg2:String!")
assertErrorMessage(error, "The interface extension type 'BaseInterface' [@n:n] has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType' [@n:n] from 'arg3:Int' to 'arg3:String")
}
Expand Down Expand Up @@ -811,10 +851,9 @@ class InterfacesImplementingInterfacesTest extends Specification {

then:
def error = thrown(SchemaProblem)
error.errors.size() == 4
error.errors.size() == 3

assertErrorMessage(error, "The interface type 'BaseInterface' [@n:n] field 'fieldA' does not have the same number of arguments as specified via interface 'InterfaceType' [@n:n]")
assertErrorMessage(error, "The interface type 'BaseInterface' [@n:n] has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType' [@n:n] from 'arg1:String =\"defaultVal\"' to 'arg1:String =\"defaultValX\"")
assertErrorMessage(error, "The interface type 'BaseInterface' [@n:n] has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType' [@n:n] from 'arg2:String' to 'arg2:String!")
assertErrorMessage(error, "The interface type 'BaseInterface' [@n:n] has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType' [@n:n] from 'arg3:Int' to 'arg3:String")
}
Expand Down Expand Up @@ -848,10 +887,9 @@ class InterfacesImplementingInterfacesTest extends Specification {

then:
def error = thrown(SchemaProblem)
error.errors.size() == 4
error.errors.size() == 3

assertErrorMessage(error, "The interface extension type 'BaseInterface' [@n:n] field 'fieldA' does not have the same number of arguments as specified via interface 'InterfaceType' [@n:n]")
assertErrorMessage(error, "The interface extension type 'BaseInterface' [@n:n] has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType' [@n:n] from 'arg1:String =\"defaultVal\"' to 'arg1:String =\"defaultValX\"")
assertErrorMessage(error, "The interface extension type 'BaseInterface' [@n:n] has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType' [@n:n] from 'arg2:String' to 'arg2:String!")
assertErrorMessage(error, "The interface extension type 'BaseInterface' [@n:n] has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType' [@n:n] from 'arg3:Int' to 'arg3:String")
}
Expand Down
18 changes: 9 additions & 9 deletions src/test/groovy/graphql/schema/idl/SchemaTypeCheckerTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -700,10 +700,10 @@ class SchemaTypeCheckerTest extends Specification {

expect:

result.size() == 3
result.get(0).getMessage().contains("field 'fieldA' does not have the same number of arguments as specified via interface 'InterfaceType'")
result.get(1).getMessage().contains("has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType'")
result.get(2).getMessage().contains("has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType'")
result.get(3).getMessage().contains("has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType'")
result.get(1).getMessage().contains("from 'arg2:String' to 'arg2:String!")
result.get(2).getMessage().contains("from 'arg3:Int' to 'arg3:String")

}

Expand Down Expand Up @@ -841,10 +841,10 @@ class SchemaTypeCheckerTest extends Specification {

expect:

result.size() == 3
result.get(0).getMessage().contains("field 'fieldA' does not have the same number of arguments as specified via interface 'InterfaceType'")
result.get(1).getMessage().contains("has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType'")
result.get(2).getMessage().contains("has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType'")
result.get(3).getMessage().contains("has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType'")
result.get(1).getMessage().contains("from 'arg2:String' to 'arg2:String!")
result.get(2).getMessage().contains("from 'arg3:Int' to 'arg3:String")
}

def "test field arguments on object type extensions must match the interface"() {
Expand Down Expand Up @@ -872,10 +872,10 @@ class SchemaTypeCheckerTest extends Specification {

expect:

result.size() == 3
result.get(0).getMessage().contains("field 'fieldA' does not have the same number of arguments as specified via interface 'InterfaceType'")
result.get(1).getMessage().contains("has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType'")
result.get(2).getMessage().contains("has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType'")
result.get(3).getMessage().contains("has tried to redefine field 'fieldB' arguments defined via interface 'InterfaceType'")
result.get(1).getMessage().contains("from 'arg2:String' to 'arg2:String!")
result.get(2).getMessage().contains("from 'arg3:Int' to 'arg3:String")
}

def "test object interface is all ok"() {
Expand Down
38 changes: 35 additions & 3 deletions src/test/groovy/graphql/schema/validation/TypesImplementInterfacesTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,40 @@ import static graphql.schema.GraphQLUnionType.newUnionType

class TypesImplementInterfacesTest extends Specification {

def "field argument defaults do not affect interface implementation validity"() {
given:
def interfaceArgument = newArgument().name("limit").type(GraphQLInt)
def implementingArgument = newArgument().name("limit").type(GraphQLInt)
if (interfaceDefault != null) {
interfaceArgument.defaultValueProgrammatic(interfaceDefault)
}
if (implementingDefault != null) {
implementingArgument.defaultValueProgrammatic(implementingDefault)
}
def account = newInterface()
.name("Account")
.field(newFieldDefinition().name("memberOf").type(GraphQLString).argument(interfaceArgument))
.build()
def host = newObject()
.name("Host")
.withInterface(account)
.field(newFieldDefinition().name("memberOf").type(GraphQLString).argument(implementingArgument))
.build()
def errors = new SchemaValidationErrorCollector()

when:
new TypesImplementInterfaces().check(host, errors)

then:
errors.getErrors().isEmpty()

where:
interfaceDefault | implementingDefault
100 | 150
100 | null
null | 150
}

GraphQLInterfaceType InterfaceType = newInterface()
.name("Interface")

Expand Down Expand Up @@ -72,7 +106,7 @@ class TypesImplementInterfacesTest extends Specification {

errorCollector.containsValidationError(ObjectDoesNotImplementItsInterfaces)
def errors = errorCollector.getErrors()
errors.size() == 6
errors.size() == 5
errors.contains(new SchemaValidationError(ObjectDoesNotImplementItsInterfaces,
"object type 'obj' does not implement interface 'Interface' because field 'friends' is missing"))
errors.contains(new SchemaValidationError(ObjectDoesNotImplementItsInterfaces,
Expand All @@ -81,8 +115,6 @@ class TypesImplementInterfacesTest extends Specification {
"object type 'obj' does not implement interface 'Interface' because field 'argField1' argument 'arg1' is defined differently"))
errors.contains(new SchemaValidationError(ObjectDoesNotImplementItsInterfaces,
"object type 'obj' does not implement interface 'Interface' because field 'argField1' argument 'arg3' is defined differently"))
errors.contains(new SchemaValidationError(ObjectDoesNotImplementItsInterfaces,
"object type 'obj' does not implement interface 'Interface' because field 'argField1' argument 'arg4' is defined differently"))
errors.contains(new SchemaValidationError(ObjectDoesNotImplementItsInterfaces,
"object type 'obj' does not implement interface 'Interface' because field 'argField2' is missing argument(s): 'arg2, arg3'"))
}
Expand Down