Skip to content

Commit

Permalink
Revert "feat: ability to specify @GraphQLName on input types w/o su…
Browse files Browse the repository at this point in the history
…ffix" (#2032)

Reverts #1960
  • Loading branch information
samuelAndalon authored Aug 19, 2024
1 parent 7c0bf6f commit dd3ad23
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 44 deletions.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2024 Expedia, Inc
* Copyright 2022 Expedia, Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -16,7 +16,6 @@

package com.expediagroup.graphql.generator.internal.extensions

import com.expediagroup.graphql.generator.annotations.GraphQLValidObjectLocations
import com.expediagroup.graphql.generator.exceptions.CouldNotGetNameOfKClassException
import com.expediagroup.graphql.generator.hooks.SchemaGeneratorHooks
import com.expediagroup.graphql.generator.internal.filters.functionFilters
Expand All @@ -29,7 +28,6 @@ import kotlin.reflect.KProperty
import kotlin.reflect.KVisibility
import kotlin.reflect.full.declaredMemberFunctions
import kotlin.reflect.full.declaredMemberProperties
import kotlin.reflect.full.findAnnotation
import kotlin.reflect.full.findParameterByName
import kotlin.reflect.full.isSubclassOf
import kotlin.reflect.full.memberFunctions
Expand Down Expand Up @@ -86,16 +84,12 @@ internal fun KClass<*>.isListType(isDirective: Boolean = false): Boolean = this.

@Throws(CouldNotGetNameOfKClassException::class)
internal fun KClass<*>.getSimpleName(isInputClass: Boolean = false): String {
val isInputOnlyLocation = this.findAnnotation<GraphQLValidObjectLocations>().let {
it != null && it.locations.size == 1 && it.locations.contains(GraphQLValidObjectLocations.Locations.INPUT_OBJECT)
}

val name = this.getGraphQLName()
?: this.simpleName
?: throw CouldNotGetNameOfKClassException(this)

return when {
isInputClass -> if (name.endsWith(INPUT_SUFFIX, true) || isInputOnlyLocation) name else "$name$INPUT_SUFFIX"
isInputClass -> if (name.endsWith(INPUT_SUFFIX, true)) name else "$name$INPUT_SUFFIX"
else -> name
}
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2024 Expedia, Inc
* Copyright 2022 Expedia, Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -19,7 +19,6 @@ package com.expediagroup.graphql.generator.internal.extensions
import com.expediagroup.graphql.generator.annotations.GraphQLIgnore
import com.expediagroup.graphql.generator.annotations.GraphQLName
import com.expediagroup.graphql.generator.annotations.GraphQLUnion
import com.expediagroup.graphql.generator.annotations.GraphQLValidObjectLocations
import com.expediagroup.graphql.generator.exceptions.CouldNotGetNameOfKClassException
import com.expediagroup.graphql.generator.hooks.NoopSchemaGeneratorHooks
import com.expediagroup.graphql.generator.hooks.SchemaGeneratorHooks
Expand Down Expand Up @@ -78,13 +77,6 @@ open class KClassExtensionsTest {
@GraphQLName("MyClassRenamedInput")
class MyClassCustomNameInput

@GraphQLValidObjectLocations([GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
class MyInputClassWithoutSuffix

@GraphQLValidObjectLocations([GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
@GraphQLName("MyClass")
class MyInputClassWithoutSuffixUsingCustomName

protected class MyProtectedClass

class MyPublicClass
Expand Down Expand Up @@ -386,10 +378,4 @@ open class KClassExtensionsTest {
assertFalse(IgnoredClass::class.isValidAdditionalType(true))
assertFalse(IgnoredClass::class.isValidAdditionalType(false))
}

@Test
fun `@GraphQLName does not apply input suffix on input only classes`() {
assertEquals("MyInputClassWithoutSuffix", MyInputClassWithoutSuffix::class.getSimpleName(isInputClass = true))
assertEquals("MyClass", MyInputClassWithoutSuffixUsingCustomName::class.getSimpleName(isInputClass = true))
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,6 @@ type MyCustomName {
}
```

:::info
By default, in order to differentiate between input and output types, all input type names are auto generated with additional
`Input` suffix. Suffix is appended only if input type name does not already end with `Input`. If you would like to change this
behavior and avoid extra suffix, you need to explicitly specify that this is an input only type.

```kotlin
// GraphQL input object type name: MyInputType
@GraphQLValidObjectLocations([GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
data class MyInputType(val id: ID)
```

You can also rename input types

```kotlin
// GraphQL input object type name: MyCustomInputType
@GraphQLValidObjectLocations([GraphQLValidObjectLocations.Locations.INPUT_OBJECT])
@GraphQLName("MyCustomInputType")
data class MyInputType(val id: ID)
```
:::

## Known Issues

Due to how we deserialize input classes, if you rename a field of an input class or an enum value you must also annotate
Expand Down

0 comments on commit dd3ad23

Please sign in to comment.