-
Notifications
You must be signed in to change notification settings - Fork 339
/
GraphQLClientGenerator.kt
278 lines (251 loc) · 12.6 KB
/
GraphQLClientGenerator.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/*
* 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.expediagroup.graphql.plugin.client.generator
import com.expediagroup.graphql.client.Generated
import com.expediagroup.graphql.plugin.client.generator.exceptions.MultipleOperationsInFileException
import com.expediagroup.graphql.plugin.client.generator.exceptions.SchemaUnavailableException
import com.expediagroup.graphql.plugin.client.generator.types.generateGraphQLObjectTypeSpec
import com.expediagroup.graphql.plugin.client.generator.types.generateVariableTypeSpec
import com.squareup.kotlinpoet.ClassName
import com.squareup.kotlinpoet.FileSpec
import com.squareup.kotlinpoet.FunSpec
import com.squareup.kotlinpoet.KModifier
import com.squareup.kotlinpoet.ParameterizedTypeName.Companion.parameterizedBy
import com.squareup.kotlinpoet.PropertySpec
import com.squareup.kotlinpoet.STRING
import com.squareup.kotlinpoet.TypeAliasSpec
import com.squareup.kotlinpoet.TypeSpec
import graphql.language.ObjectTypeDefinition
import graphql.language.OperationDefinition
import graphql.parser.Parser
import graphql.parser.ParserEnvironment
import graphql.parser.ParserOptions
import graphql.schema.idl.SchemaParser
import graphql.schema.idl.TypeDefinitionRegistry
import kotlinx.serialization.Required
import kotlinx.serialization.Serializable
import java.io.File
private const val CORE_TYPES_PACKAGE = "com.expediagroup.graphql.client.types"
/**
* GraphQL client code generator that uses [KotlinPoet](https://github.com/square/kotlinpoet) to generate Kotlin classes based on the specified GraphQL queries.
*/
class GraphQLClientGenerator(
schemaPath: String,
private val config: GraphQLClientGeneratorConfig
) {
private val documentParser: Parser = Parser()
private val typeAliases: MutableMap<String, TypeAliasSpec> = mutableMapOf()
private val sharedTypes: MutableMap<ClassName, List<TypeSpec>> = mutableMapOf()
private var generateOptionalSerializer: Boolean = false
private val graphQLSchema: TypeDefinitionRegistry
private val parserOptions: ParserOptions = ParserOptions.newParserOptions().also { this.config.parserOptions(it) }.build()
init {
graphQLSchema = parseSchema(schemaPath)
}
/**
* Generate GraphQL clients for the specified queries.
*/
fun generate(queries: List<File>): List<FileSpec> {
val result = mutableListOf<FileSpec>()
for (query in queries) {
result.addAll(generate(query))
}
// common shared types
for ((className, typeSpecs) in sharedTypes) {
val fileSpec = FileSpec.builder(className.packageName, className.simpleName)
for (type in typeSpecs) {
fileSpec.addType(type)
}
result.add(fileSpec.build())
}
// graphql type aliases
if (typeAliases.isNotEmpty()) {
val typeAliasSpec = FileSpec.builder(packageName = config.packageName, fileName = "GraphQLTypeAliases")
typeAliases.forEach { (_, alias) ->
typeAliasSpec.addTypeAlias(alias)
}
result.add(typeAliasSpec.build())
}
return result
}
/**
* Generate GraphQL client wrapper class and data classes that match the specified query.
*/
internal fun generate(queryFile: File): List<FileSpec> {
val queryConst = queryFile.readText().trim()
val queryDocument = documentParser.parseDocument(
ParserEnvironment.newParserEnvironment()
.document(queryConst)
.parserOptions(parserOptions)
.build()
)
val operationDefinitions = queryDocument.definitions.filterIsInstance<OperationDefinition>()
if (operationDefinitions.size > 1) {
throw MultipleOperationsInFileException(queryFile)
}
val fileSpecs = mutableListOf<FileSpec>()
val operationFileSpec = FileSpec.builder(packageName = config.packageName, fileName = queryFile.nameWithoutExtension.capitalizeFirstChar())
operationDefinitions.forEach { operationDefinition ->
val capitalizedOperationName = operationDefinition.name?.capitalizeFirstChar() ?: queryFile.nameWithoutExtension.capitalizeFirstChar()
val context = GraphQLClientGeneratorContext(
packageName = config.packageName,
graphQLSchema = graphQLSchema,
operationName = capitalizedOperationName,
queryDocument = queryDocument,
allowDeprecated = config.allowDeprecated,
customScalarMap = config.customScalarMap,
serializer = config.serializer,
useOptionalInputWrapper = config.useOptionalInputWrapper
)
val queryConstName = capitalizedOperationName.toUpperUnderscore()
val queryConstProp = PropertySpec.builder(queryConstName, STRING)
.addModifiers(KModifier.CONST)
.initializer("%S", queryConst)
.build()
operationFileSpec.addProperty(queryConstProp)
val rootType = findRootType(operationDefinition)
val graphQLResponseTypeSpec = generateGraphQLObjectTypeSpec(context, rootType, operationDefinition.selectionSet, "Result")
val kotlinResultTypeName = ClassName(context.packageName, "${context.operationName}.${graphQLResponseTypeSpec.name}")
val operationTypeSpec = TypeSpec.classBuilder(capitalizedOperationName)
.addAnnotation(Generated::class)
.addSuperinterface(ClassName(CORE_TYPES_PACKAGE, "GraphQLClientRequest").parameterizedBy(kotlinResultTypeName))
var queryProperty: PropertySpec = PropertySpec.builder("query", STRING, KModifier.OVERRIDE)
.initializer("%N", queryConstProp)
.build()
var operationNameProperty: PropertySpec? = if (operationDefinition.name != null) {
PropertySpec.builder("operationName", STRING, KModifier.OVERRIDE)
.initializer("%S", operationDefinition.name)
.build()
} else {
null
}
if (config.serializer == GraphQLSerializer.KOTLINX) {
operationTypeSpec.addAnnotation(Serializable::class)
queryProperty = queryProperty.toBuilder().addAnnotation(Required::class).build()
operationNameProperty = operationNameProperty?.toBuilder()?.addAnnotation(Required::class)?.build()
}
operationTypeSpec.addProperty(queryProperty)
operationNameProperty?.let {
operationTypeSpec.addProperty(it)
}
val variableType: TypeSpec? = generateVariableTypeSpec(context, operationDefinition.variableDefinitions)
if (variableType != null) {
operationTypeSpec.addType(variableType)
val variablesClassName = ClassName(config.packageName, "$capitalizedOperationName.Variables")
val variablesProperty = PropertySpec.builder("variables", variablesClassName, KModifier.OVERRIDE)
.initializer("variables")
.build()
operationTypeSpec.addProperty(variablesProperty)
val constructor = FunSpec.constructorBuilder()
.addParameter("variables", variablesClassName)
.build()
operationTypeSpec.primaryConstructor(constructor)
}
val parameterizedReturnType = ClassName("kotlin.reflect", "KClass").parameterizedBy(kotlinResultTypeName)
operationTypeSpec.addFunction(
FunSpec.builder("responseType")
.addModifiers(KModifier.OVERRIDE)
.returns(parameterizedReturnType)
.addStatement("return %T::class", kotlinResultTypeName)
.build()
)
operationTypeSpec.addType(graphQLResponseTypeSpec)
val polymorphicTypes = mutableListOf<ClassName>()
for ((superClassName, implementations) in context.polymorphicTypes) {
polymorphicTypes.add(superClassName)
val polymorphicTypeSpec = FileSpec.builder(superClassName.packageName, superClassName.simpleName)
for (implementation in implementations) {
polymorphicTypes.add(implementation)
context.typeSpecs[implementation]?.let { typeSpec ->
polymorphicTypeSpec.addType(typeSpec)
}
}
fileSpecs.add(polymorphicTypeSpec.build())
}
context.typeSpecs.minus(polymorphicTypes).forEach { (className, typeSpec) ->
val outputTypeFileSpec = FileSpec.builder(className.packageName, className.simpleName)
.addType(typeSpec)
.build()
fileSpecs.add(outputTypeFileSpec)
}
operationFileSpec.addType(operationTypeSpec.build())
fileSpecs.add(operationFileSpec.build())
// shared types
sharedTypes.putAll(context.enumClassToTypeSpecs.mapValues { listOf(it.value) })
sharedTypes.putAll(context.inputClassToTypeSpecs.mapValues { listOf(it.value) })
context.scalarClassToConverterTypeSpecs
.values
.forEach {
when (it) {
is ScalarConverterInfo.JacksonConvertersInfo -> {
sharedTypes[it.serializerClassName] = listOf(it.serializerTypeSpec)
sharedTypes[it.deserializerClassName] = listOf(it.deserializerTypeSpec)
}
is ScalarConverterInfo.KotlinxSerializerInfo -> {
sharedTypes[it.serializerClassName] = listOf(it.serializerTypeSpec)
}
}
}
typeAliases.putAll(context.typeAliases)
if (context.requireOptionalSerializer) {
generateOptionalSerializer = true
// customScalarSerializers.putAll(context.scalarClassToConverterTypeSpecs)
sharedTypes.putAll(context.optionalSerializers.mapValues { listOf(it.value) })
}
}
return fileSpecs
}
private fun findRootType(operationDefinition: OperationDefinition): ObjectTypeDefinition {
val operationNames = if (graphQLSchema.schemaDefinition().isPresent) {
graphQLSchema.schemaDefinition().get().operationTypeDefinitions.associateBy({ it.name.uppercase() }, { it.typeName.name })
} else {
mapOf(
OperationDefinition.Operation.QUERY.name to "Query",
OperationDefinition.Operation.MUTATION.name to "Mutation",
OperationDefinition.Operation.SUBSCRIPTION.name to "Subscription"
)
}
val rootType = operationNames[operationDefinition.operation.name]
return graphQLSchema.getType(rootType).get() as ObjectTypeDefinition
}
private fun parseSchema(path: String): TypeDefinitionRegistry {
val schemaFile = File(path)
return if (schemaFile.isFile) {
SchemaParser().parse(schemaFile)
} else {
val schemaInputStream = this.javaClass.classLoader.getResourceAsStream(path) ?: throw SchemaUnavailableException(path)
SchemaParser().parse(schemaInputStream)
}
}
}
/**
* This is the reccommended approach now with the deprecation of String.capitalize from the
* Kotlin stdlib in version 1.5.
*/
internal fun String.capitalizeFirstChar(): String = replaceFirstChar { if (it.isLowerCase()) it.uppercaseChar() else it }
internal fun String.toUpperUnderscore(): String {
val builder = StringBuilder()
val nameCharArray = this.toCharArray()
for ((index, c) in nameCharArray.withIndex()) {
if (c.isUpperCase() && index > 0) {
if (nameCharArray[index - 1].isLowerCase() || (index < nameCharArray.size - 1 && nameCharArray[index + 1].isLowerCase())) {
builder.append("_")
}
}
builder.append(c.uppercaseChar())
}
return builder.toString()
}