Skip to content

Remove directive info from descriptions #81

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
rickfast merged 1 commit into from
Nov 28, 2018
Merged

Remove directive info from descriptions #81

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
55 changes: 2 additions & 53 deletions src/main/kotlin/com/expedia/graphql/schema/extensions/annotationExtensions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,60 +16,9 @@ import kotlin.reflect.KParameter
import kotlin.reflect.full.findAnnotation
import com.expedia.graphql.annotations.GraphQLDirective as DirectiveAnnotation

internal fun KAnnotatedElement.graphQLDescription(): String? {
val directiveNames = listOfDirectives().map { it.normalizeDirectiveName() }
val description = this.findAnnotation<GraphQLDescription>()?.value
return formatGraphQLDescription(description, directiveNames)
}

internal fun Field.graphQLDescription(): String? {
val directiveNames = listOfDirectives().map { it.normalizeDirectiveName() }
val description = this.getAnnotation(GraphQLDescription::class.java)?.value
return formatGraphQLDescription(description, directiveNames)
}

private fun formatGraphQLDescription(description: String?, directiveNames: List<String>): String? = when {
description != null && directiveNames.isNotEmpty() ->
"""$description
|
|Directives: ${directiveNames.joinToString(", ")}
""".trimMargin()
description == null && directiveNames.isNotEmpty() ->
"Directives: ${directiveNames.joinToString(", ")}"
else -> description
}

private fun KAnnotatedElement.listOfDirectives(): List<String> {
val deprecationReason: String? = this.getDeprecationReason()?.let { "deprecated" }

return this.annotations.asSequence()
.mapNotNull { it.getDirectiveInfo() }
.map {
when {
it.effectiveName.isNullOrEmpty().not() -> "@${it.effectiveName}"
else -> null
}
}
.plus(deprecationReason)
.filterNotNull()
.toList()
}

private fun Field.listOfDirectives(): List<String> {
val deprecationReason: String? = this.getDeprecationReason()?.let { "deprecated" }
internal fun KAnnotatedElement.graphQLDescription(): String? = this.findAnnotation<GraphQLDescription>()?.value

return this.declaredAnnotations.asSequence()
.mapNotNull { it.getDirectiveInfo() }
.map {
when {
it.effectiveName.isNullOrEmpty().not() -> "@${it.effectiveName}"
else -> null
}
}
.plus(deprecationReason)
.filterNotNull()
.toList()
}
internal fun Field.graphQLDescription(): String? = this.getAnnotation(GraphQLDescription::class.java)?.value

internal fun KAnnotatedElement.getDeprecationReason(): String? = this.findAnnotation<Deprecated>()?.getReason()

Expand Down
13 changes: 0 additions & 13 deletions src/test/kotlin/com/expedia/graphql/schema/generator/DirectiveTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import com.expedia.graphql.schema.testSchemaConfig
import com.expedia.graphql.toSchema
import graphql.Scalars
import graphql.introspection.Introspection
import graphql.schema.GraphQLInputObjectType
import graphql.schema.GraphQLNonNull
import graphql.schema.GraphQLObjectType
import org.junit.jupiter.api.Test
Expand All @@ -24,21 +23,9 @@ class DirectiveTests {
val deprecatedField = result?.getFieldDefinition("deprecatedField")

assertEquals(deprecatedField?.isDeprecated, true)
assertEquals("Directives: deprecated", deprecatedField?.description)
assertEquals("this field is deprecated", deprecatedField?.deprecationReason)
}

@Test
fun `SchemaGenerator includes deprecated notice for deprecated fields`() {
val schema = toSchema(listOf(TopLevelObjectDef(QueryWithDeprecatedFields())), config = testSchemaConfig)
val topLevelQuery = schema.getObjectType("TopLevelQuery")
val query = topLevelQuery.getFieldDefinition("deprecatedArgumentQuery")
val argument = query.getArgument("input")
val deprecatedInputField = ((argument.type as? GraphQLNonNull)?.wrappedType as? GraphQLInputObjectType)?.getFieldDefinition("deprecatedField")

assertEquals("Directives: deprecated", deprecatedInputField?.description)
}

@Test
fun `SchemaGenerator marks deprecated queries and documents replacement`() {
val schema = toSchema(listOf(TopLevelObjectDef(QueryWithDeprecatedFields())), config = testSchemaConfig)
Expand Down