Skip to content

Make introspection includeDeprecated arguments non-null #4387

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

Merged
andimarek merged 1 commit into from
May 20, 2026
+57 −5
Merged

Make introspection includeDeprecated arguments non-null #4387

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
10 changes: 5 additions & 5 deletions src/main/java/graphql/introspection/Introspection.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ private static String printDefaultValue(InputValueWithState inputValueWithState,
.type(nonNull(list(nonNull(__InputValue))))
.argument(newArgument()
.name("includeDeprecated")
.type(GraphQLBoolean)
.type(nonNull(GraphQLBoolean))
.defaultValueProgrammatic(false)))
.field(newFieldDefinition()
.name("type")
Expand Down Expand Up @@ -501,7 +501,7 @@ private static String printDefaultValue(InputValueWithState inputValueWithState,
.type(list(nonNull(__Field)))
.argument(newArgument()
.name("includeDeprecated")
.type(GraphQLBoolean)
.type(nonNull(GraphQLBoolean))
.defaultValueProgrammatic(false)))
.field(newFieldDefinition()
.name("interfaces")
Expand All @@ -514,14 +514,14 @@ private static String printDefaultValue(InputValueWithState inputValueWithState,
.type(list(nonNull(__EnumValue)))
.argument(newArgument()
.name("includeDeprecated")
.type(GraphQLBoolean)
.type(nonNull(GraphQLBoolean))
.defaultValueProgrammatic(false)))
.field(newFieldDefinition()
.name("inputFields")
.type(list(nonNull(__InputValue)))
.argument(newArgument()
.name("includeDeprecated")
.type(GraphQLBoolean)
.type(nonNull(GraphQLBoolean))
.defaultValueProgrammatic(false)))
.field(newFieldDefinition()
.name("ofType")
Expand Down Expand Up @@ -629,7 +629,7 @@ public enum DirectiveLocation {
.type(nonNull(list(nonNull(__InputValue))))
.argument(newArgument()
.name("includeDeprecated")
.type(GraphQLBoolean)
.type(nonNull(GraphQLBoolean))
.defaultValueProgrammatic(false)))
.build();

Expand Down
52 changes: 52 additions & 0 deletions src/test/groovy/graphql/introspection/IntrospectionTest.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,49 @@ class IntrospectionTest extends Specification {
inputFields.size() == 2
}

@Issue("https://github.com/graphql-java/graphql-java/issues/3897")
def "includeDeprecated arguments are non-null booleans with default false"() {
def graphQL = TestUtil.graphQL("type Query { field: String }").build()

when:
def executionResult = graphQL.execute(IntrospectionQuery.INTROSPECTION_QUERY)

then:
executionResult.errors.isEmpty()

def types = executionResult.data["__schema"]["types"] as List
def typeFields = types.find { it["name"] == "__Type" }["fields"] as List
assertIncludeDeprecatedArgument(typeFields.find { it["name"] == "fields" })
assertIncludeDeprecatedArgument(typeFields.find { it["name"] == "enumValues" })
assertIncludeDeprecatedArgument(typeFields.find { it["name"] == "inputFields" })

def fieldFields = types.find { it["name"] == "__Field" }["fields"] as List
assertIncludeDeprecatedArgument(fieldFields.find { it["name"] == "args" })

def directiveFields = types.find { it["name"] == "__Directive" }["fields"] as List
assertIncludeDeprecatedArgument(directiveFields.find { it["name"] == "args" })
}

@Issue("https://github.com/graphql-java/graphql-java/issues/3897")
def "includeDeprecated arguments reject explicit null values for #fieldName"() {
def graphQL = TestUtil.graphQL("type Query { field: String }").build()

when:
def executionResult = graphQL.execute(query)

then:
executionResult.errors.size() == 1
executionResult.errors.every { it.message.contains("includeDeprecated") && it.message.contains("must not be null") }

where:
fieldName | query
"__Type.fields" | "{ __type(name: \"__Type\") { fields(includeDeprecated: null) { name } } }"
"__Type.enumValues" | "{ __type(name: \"__Type\") { enumValues(includeDeprecated: null) { name } } }"
"__Type.inputFields" | "{ __type(name: \"__Type\") { inputFields(includeDeprecated: null) { name } } }"
"__Field.args" | "{ __type(name: \"__Type\") { fields(includeDeprecated: true) { args(includeDeprecated: null) { name } } } }"
"__Directive.args" | "{ __schema { directives { args(includeDeprecated: null) { name } } } }"
}

def "can change data fetchers for introspection types"() {
def sdl = '''
type Query {
Expand Down Expand Up @@ -804,4 +847,13 @@ class IntrospectionTest extends Specification {
er.errors.isEmpty()
}

private static void assertIncludeDeprecatedArgument(Map field) {
def argument = (field["args"] as List).find { it["name"] == "includeDeprecated" }
assert argument["defaultValue"] == "false"
assert argument["type"]["kind"] == "NON_NULL"
assert argument["type"]["name"] == null
assert argument["type"]["ofType"]["kind"] == "SCALAR"
assert argument["type"]["ofType"]["name"] == "Boolean"
}

}