Skip to content
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

fix: Sort arguments by name in SDL #183

Merged
merged 1 commit into from
Feb 2, 2025
+25 −20
Merged

fix: Sort arguments by name in SDL #183

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
11 changes: 5 additions & 6 deletions kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/SchemaPrinter.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,7 @@ class SchemaPrinter(private val config: SchemaPrinterConfig = SchemaPrinterConfi
// Input Types
// https://spec.graphql.org/draft/#sec-Input-Objects
val inputTypes = buildString {
schemaTypes[TypeKind.INPUT_OBJECT]?.filter { !it.inputFields.isNullOrEmpty() }
?.forEachIndexed { index, type ->
schemaTypes[TypeKind.INPUT_OBJECT]?.forEachIndexed { index, type ->
if (index > 0) {
appendLine()
}
Expand All @@ -184,7 +183,7 @@ class SchemaPrinter(private val config: SchemaPrinterConfig = SchemaPrinterConfi
if (index > 0) {
appendLine()
}
val args = directive.args.takeIf { it.isNotEmpty() }
val args = directive.args.sortedByName().takeIf { it.isNotEmpty() }
?.joinToString(", ", prefix = "(", postfix = ")") { arg ->
arg.name + ": " + arg.type.typeReference() + arg.defaultInfo()
} ?: ""
Expand Down Expand Up @@ -263,15 +262,15 @@ class SchemaPrinter(private val config: SchemaPrinterConfig = SchemaPrinterConfi
// otherwise print them on a single line
if (field.args.any { it.isDeprecated || (config.includeDescriptions && !it.description.isNullOrBlank()) }) {
appendLine("${indentation}${field.name}(")
field.args.forEach { arg ->
field.args.sortedByName().forEach { arg ->
val argsIndentation = "$indentation$indentation"
appendDescription(arg, argsIndentation)
appendLine("$argsIndentation${arg.name}: ${arg.type.typeReference()}${arg.defaultInfo()}${arg.deprecationInfo()}")
}
appendLine("${indentation}): ${field.type.typeReference()}${field.deprecationInfo()}")
} else {
val args =
field.args.takeIf { it.isNotEmpty() }?.joinToString(", ", prefix = "(", postfix = ")") { arg ->
val args = field.args.sortedByName().takeIf { it.isNotEmpty() }
?.joinToString(", ", prefix = "(", postfix = ")") { arg ->
arg.name + ": " + arg.type.typeReference() + arg.defaultInfo()
} ?: ""
appendLine("${indentation}${field.name}$args: ${field.type.typeReference()}${field.deprecationInfo()}")
Expand Down
1 change: 0 additions & 1 deletion kgraphql/src/main/kotlin/com/apurebase/kgraphql/schema/model/ast/TypeNode.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ sealed class TypeNode(override val loc: Location?) : ASTNode() {

class NonNullTypeNode(loc: Location?, val type: TypeNode) : TypeNode(loc)


val isNullable get() = this !is NonNullTypeNode

val isList get() = this is ListTypeNode || (this is NonNullTypeNode && type is ListTypeNode)
Expand Down
33 changes: 20 additions & 13 deletions kgraphql/src/test/kotlin/com/apurebase/kgraphql/schema/SchemaPrinterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ class SchemaPrinterTest {
returnType = linked
nullable = true
description = "link to pdf representation of scenario"
resolver { scenario: Scenario -> null }
resolver { null }
}
}
}
Expand Down Expand Up @@ -163,20 +163,20 @@ class SchemaPrinterTest {
}

sealed class Child
data class Child1(val one: String): Child()
data class Child2(val two: String?): Child()
data class Child1(val one: String) : Child()
data class Child2(val two: String?) : Child()

@Test
fun `schema with union types out of sealed classes should be printed as expected`() {
val schema = KGraphQL.schema {
query("child") {
resolver<Child> { -> Child1("one") }
resolver<Child> { Child1("one") }
}
query("childs") {
resolver<List<Child>> { -> listOf(Child2("one")) }
resolver<List<Child>> { listOf(Child2("one")) }
}
query("nullchilds") {
resolver<List<Child?>?> { -> null }
resolver<List<Child?>?> { null }
}
}

Expand Down Expand Up @@ -367,7 +367,7 @@ class SchemaPrinterTest {
getNullString: String
getObject(nullObject: Boolean!): TestObject
getString: String!
randomInt(min: Int!, max: Int): Int!
randomInt(max: Int, min: Int!): Int!
randomString(possibleReturns: [String!]!): String!
}

Expand Down Expand Up @@ -460,7 +460,7 @@ class SchemaPrinterTest {

type Query {
getStringsForTypes(types: [TestEnum!] = [TYPE1, TYPE2]): [String!]!
getStringWithDefault(type: TestEnum! = TYPE1, string: String!): String!
getStringWithDefault(string: String!, type: TestEnum! = TYPE1): String!
}

enum TestEnum {
Expand Down Expand Up @@ -493,6 +493,7 @@ class SchemaPrinterTest {
}
}
query("data") {
@Suppress("UNUSED_ANONYMOUS_PARAMETER")
resolver { oldOptional: String?, new: String -> "" }.withArgs {
arg(String::class, typeOf<String?>()) {
name = "oldOptional"; defaultValue = "\"\""; deprecate("deprecated arg")
Expand All @@ -514,8 +515,8 @@ class SchemaPrinterTest {

type Query {
data(
oldOptional: String = "" @deprecated(reason: "deprecated arg")
new: String!
oldOptional: String = "" @deprecated(reason: "deprecated arg")
): String!
}

Expand Down Expand Up @@ -543,6 +544,9 @@ class SchemaPrinterTest {
description = "This is the name"
}
}
inputType<TestObject> {
name = "TestObjectInput"
}
enum<TestEnum> {
value(TestEnum.TYPE1) {
description = "Enum value description"
Expand Down Expand Up @@ -594,7 +598,7 @@ class SchemaPrinterTest {
"Add a test object"
"With some multi-line description"
"(& special characters like " and \n)"
addObject(toAdd: TestObject!): TestObject!
addObject(toAdd: TestObjectInput!): TestObject!
}

"Query object"
Expand Down Expand Up @@ -623,7 +627,7 @@ class SchemaPrinterTest {
TYPE2
}

input TestObject {
input TestObjectInput {
name: String!
}

Expand All @@ -638,6 +642,9 @@ class SchemaPrinterTest {
description = "This is the name"
}
}
inputType<TestObject> {
name = "TestObjectInput"
}
enum<TestEnum> {
value(TestEnum.TYPE1) {
description = "Enum value description"
Expand All @@ -663,7 +670,7 @@ class SchemaPrinterTest {

SchemaPrinter(SchemaPrinterConfig(includeDescriptions = false)).print(schema) shouldBeEqualTo """
type Mutation {
addObject(toAdd: TestObject!): TestObject!
addObject(toAdd: TestObjectInput!): TestObject!
}

type Query {
Expand All @@ -683,7 +690,7 @@ class SchemaPrinterTest {
TYPE2
}

input TestObject {
input TestObjectInput {
name: String!
}

Expand Down