-
Notifications
You must be signed in to change notification settings - Fork 91
/
CodeGen.kt
769 lines (706 loc) · 33.2 KB
/
CodeGen.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
/*
*
* Copyright 2020 Netflix, 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
*
* http://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.netflix.graphql.dgs.codegen
import com.netflix.graphql.dgs.codegen.generators.java.*
import com.netflix.graphql.dgs.codegen.generators.kotlin.*
import com.netflix.graphql.dgs.codegen.generators.kotlin2.*
import com.netflix.graphql.dgs.codegen.generators.shared.DocFileSpec
import com.netflix.graphql.dgs.codegen.generators.shared.DocGenerator
import com.netflix.graphql.dgs.codegen.generators.shared.SchemaExtensionsUtils.findEnumExtensions
import com.netflix.graphql.dgs.codegen.generators.shared.SchemaExtensionsUtils.findInputExtensions
import com.netflix.graphql.dgs.codegen.generators.shared.SchemaExtensionsUtils.findInterfaceExtensions
import com.netflix.graphql.dgs.codegen.generators.shared.SchemaExtensionsUtils.findTypeExtensions
import com.netflix.graphql.dgs.codegen.generators.shared.SchemaExtensionsUtils.findUnionExtensions
import com.netflix.graphql.dgs.codegen.generators.shared.excludeSchemaTypeExtension
import com.squareup.javapoet.AnnotationSpec
import com.squareup.javapoet.ClassName
import com.squareup.javapoet.JavaFile
import com.squareup.javapoet.TypeSpec
import com.squareup.kotlinpoet.FileSpec
import com.squareup.kotlinpoet.KModifier
import graphql.language.*
import graphql.parser.InvalidSyntaxException
import graphql.parser.MultiSourceReader
import graphql.parser.Parser
import graphql.parser.ParserOptions
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import java.io.*
import java.lang.annotation.RetentionPolicy
import java.nio.charset.StandardCharsets
import java.nio.file.Path
import java.nio.file.Paths
import java.util.zip.ZipFile
import javax.lang.model.element.Modifier
import com.squareup.kotlinpoet.AnnotationSpec as KAnnotationSpec
import com.squareup.kotlinpoet.ClassName as KClassName
import com.squareup.kotlinpoet.TypeSpec as KTypeSpec
class CodeGen(private val config: CodeGenConfig) {
companion object {
private const val SDL_MAX_ALLOWED_SCHEMA_TOKENS: Int = Int.MAX_VALUE
private val logger: Logger = LoggerFactory.getLogger(CodeGen::class.java)
}
private val document = buildDocument()
private val requiredTypeCollector = RequiredTypeCollector(
document = document,
config = config
)
@Suppress("DuplicatedCode")
fun generate(): CodeGenResult {
val codeGenResult = when (config.language) {
Language.JAVA -> generateJava()
Language.KOTLIN -> generateKotlin()
}
if (config.writeToFiles) {
codeGenResult.javaDataTypes.forEach { it.writeTo(config.outputDir) }
codeGenResult.javaInterfaces.forEach { it.writeTo(config.outputDir) }
codeGenResult.javaEnumTypes.forEach { it.writeTo(config.outputDir) }
codeGenResult.javaDataFetchers.forEach { it.writeTo(config.examplesOutputDir) }
codeGenResult.javaQueryTypes.forEach { it.writeTo(config.outputDir) }
codeGenResult.clientProjections.forEach {
try {
it.writeTo(config.outputDir)
} catch (ex: Exception) {
println(ex.message)
}
}
codeGenResult.javaConstants.forEach { it.writeTo(config.outputDir) }
codeGenResult.kotlinDataTypes.forEach { it.writeTo(config.outputDir) }
codeGenResult.kotlinInputTypes.forEach { it.writeTo(config.outputDir) }
codeGenResult.kotlinInterfaces.forEach { it.writeTo(config.outputDir) }
codeGenResult.kotlinEnumTypes.forEach { it.writeTo(config.outputDir) }
codeGenResult.kotlinDataFetchers.forEach { it.writeTo(config.examplesOutputDir) }
codeGenResult.kotlinConstants.forEach { it.writeTo(config.outputDir) }
codeGenResult.kotlinClientTypes.forEach { it.writeTo(config.outputDir) }
codeGenResult.docFiles.forEach { it.writeTo(config.generatedDocsFolder) }
}
return codeGenResult
}
/**
* Build a [Document] containing the combined schemas from
* [config].
*/
private fun buildDocument(): Document {
val options = ParserOptions.getDefaultParserOptions().transform { builder ->
builder.maxTokens(SDL_MAX_ALLOWED_SCHEMA_TOKENS).maxWhitespaceTokens(SDL_MAX_ALLOWED_SCHEMA_TOKENS)
}
val parser = Parser()
val readerBuilder = MultiSourceReader.newMultiSourceReader()
val debugReaderBuilder = MultiSourceReader.newMultiSourceReader()
loadSchemaReaders(readerBuilder, debugReaderBuilder)
// process schema from dependencies
config.schemaJarFilesFromDependencies.forEach {
val zipFile = ZipFile(it)
zipFile.entries().toList().forEach { entry ->
if (!entry.isDirectory && entry.name.startsWith("META-INF") &&
(entry.name.endsWith(".graphqls") || entry.name.endsWith(".graphql"))
) {
logger.info("Generating schema from ${it.name}: ${entry.name}")
readerBuilder.reader(InputStreamReader(zipFile.getInputStream(entry), StandardCharsets.UTF_8), "codegen")
}
}
}
val document = readerBuilder.build().use { reader ->
try {
parser.parseDocument(reader, options)
} catch (exception: InvalidSyntaxException) {
// check if the schema is empty
if (exception.sourcePreview.trim() == "") {
logger.warn("Schema is empty")
// return an empty document
return Document.newDocument().build()
} else {
throw CodeGenSchemaParsingException(debugReaderBuilder.build(), exception)
}
}
}
return document
}
/**
* Loads the given [MultiSourceReader.Builder] references with the sources that will be used to provide
* the schema information for the parser.
*/
private fun loadSchemaReaders(vararg readerBuilders: MultiSourceReader.Builder) {
readerBuilders.forEach { rb ->
val schemaFiles = config.schemaFiles.sorted()
.flatMap { it.walkTopDown() }
.filter { it.isFile }
.filter { it.name.endsWith(".graphql") || it.name.endsWith(".graphqls") }
for (schemaFile in schemaFiles) {
rb.string("\n", "codegen")
rb.reader(schemaFile.reader(), schemaFile.name)
}
for (schema in config.schemas) {
rb.string(schema, null)
}
}
}
private fun generateJava(): CodeGenResult {
val definitions = document.definitions
// data types
val dataTypesResult = generateJavaDataType(definitions)
val inputTypesResult = generateJavaInputType(definitions)
val interfacesResult = generateJavaInterfaces(definitions)
val unionsResult = generateJavaUnions(definitions)
val enumsResult = generateJavaEnums(definitions)
val constantsClass = ConstantsGenerator(config, document).generate()
// Client
val client = generateJavaClientApi(definitions)
val entitiesClient = generateJavaClientEntitiesApi(definitions)
val entitiesRepresentationsTypes = generateJavaClientEntitiesRepresentations(definitions)
// Data Fetchers
val dataFetchersResult = generateJavaDataFetchers(definitions)
val generatedAnnotation = generateJavaGeneratedAnnotation(config)
var docFiles = generateDocFiles(definitions)
return dataTypesResult
.merge(dataFetchersResult)
.merge(inputTypesResult)
.merge(unionsResult)
.merge(enumsResult)
.merge(interfacesResult)
.merge(client)
.merge(entitiesClient)
.merge(entitiesRepresentationsTypes)
.merge(constantsClass)
.merge(generatedAnnotation)
.merge(docFiles)
}
private fun generateJavaEnums(definitions: Collection<Definition<*>>): CodeGenResult {
return definitions.asSequence()
.filterIsInstance<EnumTypeDefinition>()
.excludeSchemaTypeExtension()
.filter { config.generateDataTypes || config.generateInterfaces || it.name in requiredTypeCollector.requiredTypes }
.map { EnumTypeGenerator(config).generate(it, findEnumExtensions(it.name, definitions)) }
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
private fun generateJavaUnions(definitions: Collection<Definition<*>>): CodeGenResult {
return definitions.asSequence()
.filterIsInstance<UnionTypeDefinition>()
.excludeSchemaTypeExtension()
.filter { config.generateDataTypes || config.generateInterfaces || it.name in requiredTypeCollector.requiredTypes }
.map { UnionTypeGenerator(config, document).generate(it, findUnionExtensions(it.name, definitions)) }
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
private fun generateJavaInterfaces(definitions: Collection<Definition<*>>): CodeGenResult {
return definitions.asSequence()
.filterIsInstance<InterfaceTypeDefinition>()
.excludeSchemaTypeExtension()
.filter { config.generateDataTypes || config.generateInterfaces || it.name in requiredTypeCollector.requiredTypes }
.map {
val extensions = findInterfaceExtensions(it.name, definitions)
InterfaceGenerator(config, document).generate(it, extensions)
}
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
private fun generateJavaClientApi(definitions: Collection<Definition<*>>): CodeGenResult {
val methodNames = mutableSetOf<String>()
return if (config.generateClientApi || config.generateClientApiv2) {
definitions.asSequence()
.filterIsInstance<ObjectTypeDefinition>()
.filter { it.name == "Query" || it.name == "Mutation" || it.name == "Subscription" }
.sortedBy { it.name.length }
.map {
ClientApiGenerator(config, document).generate(it, methodNames)
}
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
} else CodeGenResult()
}
private fun generateJavaClientEntitiesApi(definitions: Collection<Definition<*>>): CodeGenResult {
return if (config.generateClientApi || config.generateClientApiv2) {
val federatedDefinitions = definitions.asSequence()
.filterIsInstance<ObjectTypeDefinition>()
.filter { it.hasDirective("key") }
.toList()
ClientApiGenerator(config, document).generateEntities(federatedDefinitions)
} else CodeGenResult()
}
private fun generateJavaClientEntitiesRepresentations(definitions: Collection<Definition<*>>): CodeGenResult {
return if (config.generateClientApi || config.generateClientApiv2) {
val generatedRepresentations = mutableMapOf<String, Any>()
return definitions.asSequence()
.filterIsInstance<ObjectTypeDefinition>()
.filter { it.hasDirective("key") }
.map { d ->
EntitiesRepresentationTypeGenerator(config, document).generate(d, generatedRepresentations)
}.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
} else CodeGenResult()
}
private fun generateJavaDataFetchers(definitions: Collection<Definition<*>>): CodeGenResult {
return definitions.asSequence()
.filterIsInstance<ObjectTypeDefinition>()
.filter { it.name == "Query" }
.map { DatafetcherGenerator(config, document).generate(it) }
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
private fun generateJavaGeneratedAnnotation(config: CodeGenConfig): CodeGenResult {
return if (config.addGeneratedAnnotation) {
val retention = AnnotationSpec.builder(java.lang.annotation.Retention::class.java)
.addMember("value", "${'$'}T.${'$'}N", RetentionPolicy::class.java, "CLASS")
.build()
val generated =
TypeSpec.annotationBuilder(ClassName.get(config.packageName, "Generated"))
.addModifiers(Modifier.PUBLIC)
.addAnnotation(retention)
.build()
val generatedFile = JavaFile.builder(config.packageName, generated).build()
CodeGenResult(javaInterfaces = listOf(generatedFile))
} else {
CodeGenResult()
}
}
private fun generateJavaDataType(definitions: Collection<Definition<*>>): CodeGenResult {
return definitions.asSequence()
.filterIsInstance<ObjectTypeDefinition>()
.excludeSchemaTypeExtension()
.filter { it.name != "Query" && it.name != "Mutation" && it.name != "RelayPageInfo" }
.filter { config.generateInterfaces || config.generateDataTypes || it.name in requiredTypeCollector.requiredTypes }
.map {
DataTypeGenerator(config, document).generate(it, findTypeExtensions(it.name, definitions))
}.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
private fun generateJavaInputType(definitions: Collection<Definition<*>>): CodeGenResult {
val inputTypes = definitions.asSequence()
.filterIsInstance<InputObjectTypeDefinition>()
.excludeSchemaTypeExtension()
.filter { config.generateDataTypes || it.name in requiredTypeCollector.requiredTypes }
return inputTypes
.map { d ->
InputTypeGenerator(config, document).generate(d, findInputExtensions(d.name, definitions))
}.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
private fun generateKotlin(): CodeGenResult {
val definitions = document.definitions
val requiredTypeCollector = RequiredTypeCollector(
document = document,
config = config
)
val requiredTypes = requiredTypeCollector.requiredTypes
val dataTypes = if (config.generateKotlinNullableClasses) {
CodeGenResult(
kotlinDataTypes = generateKotlin2DataTypes(config, document, requiredTypes),
kotlinInputTypes = generateKotlin2InputTypes(config, document, requiredTypes),
kotlinInterfaces = generateKotlin2Interfaces(config, document),
kotlinEnumTypes = generateKotlin2EnumTypes(config, document, requiredTypes),
kotlinConstants = KotlinConstantsGenerator(config, document).generate().kotlinConstants
)
} else {
val datatypesResult = generateKotlinDataTypes(definitions)
val inputTypes = generateKotlinInputTypes(definitions)
val interfacesResult = generateKotlinInterfaceTypes(definitions)
val unionResult = definitions.asSequence()
.filterIsInstance<UnionTypeDefinition>()
.excludeSchemaTypeExtension()
.map {
val extensions = findUnionExtensions(it.name, definitions)
KotlinUnionTypeGenerator(config).generate(it, extensions)
}
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
val enumsResult = definitions.asSequence()
.filterIsInstance<EnumTypeDefinition>()
.excludeSchemaTypeExtension()
.filter { config.generateDataTypes || it.name in requiredTypeCollector.requiredTypes }
.map {
val extensions = findEnumExtensions(it.name, definitions)
KotlinEnumTypeGenerator(config).generate(it, extensions)
}
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
val constantsClass = KotlinConstantsGenerator(config, document).generate()
datatypesResult
.merge(inputTypes)
.merge(interfacesResult)
.merge(unionResult)
.merge(enumsResult)
.merge(constantsClass)
}
val clientTypes = if (config.generateKotlinClosureProjections) {
CodeGenResult(
kotlinClientTypes = generateKotlin2ClientTypes(config, document)
)
} else {
val client = generateJavaClientApi(definitions)
val entitiesClient = generateJavaClientEntitiesApi(definitions)
val entitiesRepresentationsTypes = generateJavaClientEntitiesRepresentations(definitions)
client.merge(entitiesClient).merge(entitiesRepresentationsTypes)
}
val generatedAnnotation = generateKotlinGeneratedAnnotation(config)
return dataTypes.merge(clientTypes)
.merge(generatedAnnotation)
}
private fun generateKotlinGeneratedAnnotation(config: CodeGenConfig): CodeGenResult {
return if (config.addGeneratedAnnotation) {
val generated = KTypeSpec.annotationBuilder(KClassName(config.packageName, "Generated"))
.addModifiers(KModifier.PUBLIC)
.addAnnotation(
KAnnotationSpec
.builder(Retention::class)
.addMember("value = %T.%N", AnnotationRetention::class, "BINARY")
.build()
)
.build()
val generatedFile =
FileSpec.builder(config.packageName, "Generated").addType(generated).build()
CodeGenResult(kotlinInterfaces = listOf(generatedFile))
} else {
CodeGenResult()
}
}
private fun generateKotlinClientEntitiesRepresentations(definitions: Collection<Definition<*>>): CodeGenResult {
return if (config.generateClientApi) {
val generatedRepresentations = mutableMapOf<String, Any>()
return definitions.asSequence()
.filterIsInstance<ObjectTypeDefinition>()
.filter { it.hasDirective("key") }
.map { d ->
KotlinEntitiesRepresentationTypeGenerator(config, document).generate(d, generatedRepresentations)
}.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
} else CodeGenResult()
}
private fun generateKotlinInputTypes(definitions: Collection<Definition<*>>): CodeGenResult {
return definitions.asSequence()
.filterIsInstance<InputObjectTypeDefinition>()
.excludeSchemaTypeExtension()
.filter { config.generateDataTypes || it.name in requiredTypeCollector.requiredTypes }
.map {
KotlinInputTypeGenerator(config, document).generate(it, findInputExtensions(it.name, definitions))
}
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
private fun generateKotlinDataTypes(definitions: Collection<Definition<*>>): CodeGenResult {
return definitions.asSequence()
.filterIsInstance<ObjectTypeDefinition>()
.excludeSchemaTypeExtension()
.filter { it.name != "Query" && it.name != "Mutation" && it.name != "RelayPageInfo" }
.filter { config.generateDataTypes || it.name in requiredTypeCollector.requiredTypes }
.map {
val extensions = findTypeExtensions(it.name, definitions)
KotlinDataTypeGenerator(config, document).generate(it, extensions)
}
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
private fun generateKotlinInterfaceTypes(definitions: Collection<Definition<*>>): CodeGenResult {
if (!config.generateDataTypes && !config.generateInterfaces) {
return CodeGenResult()
}
return definitions.asSequence()
.filterIsInstance<InterfaceTypeDefinition>()
.excludeSchemaTypeExtension()
.map {
val extensions = findInterfaceExtensions(it.name, definitions)
KotlinInterfaceTypeGenerator(config, document).generate(it, extensions)
}
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
private fun generateDocFiles(definitions: Collection<Definition<*>>): CodeGenResult {
if (!config.generateDocs) {
return CodeGenResult()
}
return definitions.asSequence()
.map {
DocGenerator(config, document).generate(it)
}
.fold(CodeGenResult()) { t: CodeGenResult, u: CodeGenResult -> t.merge(u) }
}
}
class CodeGenConfig(
var schemas: Set<String> = emptySet(),
var schemaFiles: Set<File> = emptySet(),
var schemaJarFilesFromDependencies: List<java.io.File> = emptyList(),
var outputDir: Path = Paths.get("generated"),
var examplesOutputDir: Path = Paths.get("generated-examples"),
var writeToFiles: Boolean = false,
var packageName: String = "com.netflix.${Paths.get("").toAbsolutePath().fileName}.generated",
private val subPackageNameClient: String = "client",
private val subPackageNameDatafetchers: String = "datafetchers",
private val subPackageNameTypes: String = "types",
private val subPackageNameDocs: String = "docs",
var language: Language = Language.JAVA,
var generateBoxedTypes: Boolean = false,
var generateIsGetterForPrimitiveBooleanFields: Boolean = false,
var generateClientApi: Boolean = false,
var generateClientApiv2: Boolean = false,
var generateInterfaces: Boolean = false,
var generateKotlinNullableClasses: Boolean = false,
var generateKotlinClosureProjections: Boolean = false,
var typeMapping: Map<String, String> = emptyMap(),
var includeQueries: Set<String> = emptySet(),
var includeMutations: Set<String> = emptySet(),
var includeSubscriptions: Set<String> = emptySet(),
var skipEntityQueries: Boolean = false,
var shortProjectionNames: Boolean = false,
var generateDataTypes: Boolean = true,
var omitNullInputFields: Boolean = false,
var maxProjectionDepth: Int = 10,
var kotlinAllFieldsOptional: Boolean = false,
/** If enabled, the names of the classes available via the DgsConstant class will be snake cased.*/
var snakeCaseConstantNames: Boolean = false,
var generateInterfaceSetters: Boolean = true,
var generateInterfaceMethodsForInterfaceFields: Boolean = false,
var generateDocs: Boolean = false,
var generatedDocsFolder: Path = Paths.get("generated-docs"),
var includeImports: Map<String, String> = emptyMap(),
var includeEnumImports: Map<String, Map<String, String>> = emptyMap(),
var includeClassImports: Map<String, Map<String, String>> = emptyMap(),
var generateCustomAnnotations: Boolean = false,
var javaGenerateAllConstructor: Boolean = true,
var implementSerializable: Boolean = false,
var addGeneratedAnnotation: Boolean = false,
var addDeprecatedAnnotation: Boolean = false
) {
val packageNameClient: String = "$packageName.$subPackageNameClient"
val packageNameDatafetchers: String = "$packageName.$subPackageNameDatafetchers"
val packageNameTypes: String = "$packageName.$subPackageNameTypes"
val packageNameDocs: String = "$packageName.$subPackageNameDocs"
override fun toString(): String {
return """
--output-dir=$outputDir
--package-name=$packageName
--sub-package-name-client=$subPackageNameClient
--sub-package-name-datafetchers=$subPackageNameDatafetchers
--sub-package-name-types=$subPackageNameTypes
--sub-package-name-docs=$subPackageNameDocs
${if (generateBoxedTypes) "--generate-boxed-types" else ""}
${if (writeToFiles) "--write-to-disk" else ""}
--language=$language
${if (generateClientApi) "--generate-client" else ""}
${if (generateDataTypes) "--generate-data-types" else "--skip-generate-data-types"}
${includeQueries.joinToString("\n") { "--include-query=$it" }}
${includeMutations.joinToString("\n") { "--include-mutation=$it" }}
${if (skipEntityQueries) "--skip-entities" else ""}
${typeMapping.map { "--type-mapping ${it.key}=${it.value}" }.joinToString("\n")}
${if (shortProjectionNames) "--short-projection-names" else ""}
${if (addGeneratedAnnotation) "--add-generated-annotation" else ""}
${schemas.joinToString(" ")}
""".trimIndent()
}
}
enum class Language {
JAVA,
KOTLIN,
}
data class CodeGenResult(
val javaDataTypes: List<JavaFile> = listOf(),
val javaInterfaces: List<JavaFile> = listOf(),
val javaEnumTypes: List<JavaFile> = listOf(),
val javaDataFetchers: List<JavaFile> = listOf(),
val javaQueryTypes: List<JavaFile> = listOf(),
val clientProjections: List<JavaFile> = listOf(),
val javaConstants: List<JavaFile> = listOf(),
val kotlinDataTypes: List<FileSpec> = listOf(),
val kotlinInputTypes: List<FileSpec> = listOf(),
val kotlinInterfaces: List<FileSpec> = listOf(),
val kotlinEnumTypes: List<FileSpec> = listOf(),
val kotlinDataFetchers: List<FileSpec> = listOf(),
val kotlinConstants: List<FileSpec> = listOf(),
val kotlinClientTypes: List<FileSpec> = listOf(),
val docFiles: List<DocFileSpec> = listOf()
) {
fun merge(current: CodeGenResult): CodeGenResult {
val javaDataTypes = this.javaDataTypes.plus(current.javaDataTypes)
val javaInterfaces = this.javaInterfaces.plus(current.javaInterfaces)
val javaEnumTypes = this.javaEnumTypes.plus(current.javaEnumTypes)
val javaDataFetchers = this.javaDataFetchers.plus(current.javaDataFetchers)
val javaQueryTypes = this.javaQueryTypes.plus(current.javaQueryTypes)
val clientProjections = this.clientProjections.plus(current.clientProjections).distinct()
val javaConstants = this.javaConstants.plus(current.javaConstants)
val kotlinDataTypes = this.kotlinDataTypes.plus(current.kotlinDataTypes)
val kotlinInputTypes = this.kotlinInputTypes.plus(current.kotlinInputTypes)
val kotlinInterfaces = this.kotlinInterfaces.plus(current.kotlinInterfaces)
val kotlinEnumTypes = this.kotlinEnumTypes.plus(current.kotlinEnumTypes)
val kotlinDataFetchers = this.kotlinDataFetchers.plus(current.kotlinDataFetchers)
val kotlinConstants = this.kotlinConstants.plus(current.kotlinConstants)
val kotlinClientTypes = this.kotlinClientTypes.plus(current.kotlinClientTypes)
val docFiles = this.docFiles.plus(current.docFiles)
return CodeGenResult(
javaDataTypes = javaDataTypes,
javaInterfaces = javaInterfaces,
javaEnumTypes = javaEnumTypes,
javaDataFetchers = javaDataFetchers,
javaQueryTypes = javaQueryTypes,
clientProjections = clientProjections,
javaConstants = javaConstants,
kotlinDataTypes = kotlinDataTypes,
kotlinInputTypes = kotlinInputTypes,
kotlinInterfaces = kotlinInterfaces,
kotlinEnumTypes = kotlinEnumTypes,
kotlinDataFetchers = kotlinDataFetchers,
kotlinConstants = kotlinConstants,
kotlinClientTypes = kotlinClientTypes,
docFiles = docFiles
)
}
fun javaSources(): List<JavaFile> {
return javaDataTypes
.asSequence()
.plus(javaInterfaces)
.plus(javaEnumTypes)
.plus(javaDataFetchers)
.plus(javaQueryTypes)
.plus(clientProjections)
.plus(javaConstants)
.toList()
}
fun kotlinSources(): List<FileSpec> {
return kotlinDataTypes
.asSequence()
.plus(kotlinInputTypes)
.plus(kotlinInterfaces)
.plus(kotlinEnumTypes)
.plus(kotlinConstants)
.plus(kotlinClientTypes)
.toList()
}
}
fun List<FieldDefinition>.filterSkipped(): List<FieldDefinition> {
return this.filter { it.directives.none { d -> d.name == "skipcodegen" } }
}
fun Sequence<FieldDefinition>.filterSkipped(): Sequence<FieldDefinition> {
return this.filter { it.directives.none { d -> d.name == "skipcodegen" } }
}
fun List<FieldDefinition>.filterIncludedInConfig(definitionName: String, config: CodeGenConfig): List<FieldDefinition> {
return when (definitionName) {
"Query" -> {
if (config.includeQueries.isEmpty()) {
this
} else {
this.filter { it.name in config.includeQueries }
}
}
"Mutation" -> {
if (config.includeMutations.isEmpty()) {
this
} else {
this.filter { it.name in config.includeMutations }
}
}
"Subscription" -> {
if (config.includeSubscriptions.isEmpty()) {
this
} else {
this.filter { it.name in config.includeSubscriptions }
}
}
else -> this
}
}
fun <T : DirectivesContainer<*>> DirectivesContainer<T>.shouldSkip(
config: CodeGenConfig
): Boolean {
return directives.any { it.name == "skipcodegen" } || config.typeMapping.containsKey((this as NamedNode<*>).name)
}
fun TypeDefinition<*>.fieldDefinitions(): List<FieldDefinition> {
return when (this) {
is ObjectTypeDefinition -> this.fieldDefinitions
is InterfaceTypeDefinition -> this.fieldDefinitions
else -> emptyList()
}
}
fun Type<*>.findTypeDefinition(
document: Document,
excludeExtensions: Boolean = false,
includeBaseTypes: Boolean = false,
includeScalarTypes: Boolean = false
): TypeDefinition<*>? {
return when (this) {
is NonNullType -> {
this.type.findTypeDefinition(document, excludeExtensions, includeBaseTypes, includeScalarTypes)
}
is ListType -> {
this.type.findTypeDefinition(document, excludeExtensions, includeBaseTypes, includeScalarTypes)
}
else -> {
if (includeBaseTypes && this.isBaseType()) {
this.findBaseTypeDefinition()
} else {
document.definitions.asSequence().filterIsInstance<TypeDefinition<*>>().find {
if (it is ScalarTypeDefinition) {
includeScalarTypes && it.name == (this as TypeName).name
} else {
it.name == (this as TypeName).name && (!excludeExtensions || it !is ObjectTypeExtensionDefinition)
}
}
}
}
}
}
fun Type<*>.isBaseType(): Boolean {
return when (this) {
is NonNullType -> {
this.type.isBaseType()
}
is ListType -> {
this.type.isBaseType()
}
is TypeName -> {
when (this.name) {
"String", "Boolean", "Float", "Int" -> true
else -> false
}
}
else -> {
false
}
}
}
fun Type<*>.findBaseTypeDefinition(): TypeDefinition<*>? {
return when (this) {
is NonNullType -> {
this.type.findBaseTypeDefinition()
}
is ListType -> {
this.type.findBaseTypeDefinition()
}
is TypeName -> {
when (this.name) {
"String" -> ScalarTypeDefinition.newScalarTypeDefinition().name("String").build()
"Boolean" -> ScalarTypeDefinition.newScalarTypeDefinition().name("Boolean").build()
"Float" -> ScalarTypeDefinition.newScalarTypeDefinition().name("Float").build()
"Int" -> ScalarTypeDefinition.newScalarTypeDefinition().name("Int").build()
else -> null
}
}
else -> {
null
}
}
}
class CodeGenSchemaParsingException(
schemaReader: Reader,
invalidSyntaxException: InvalidSyntaxException
) : RuntimeException(buildMessage(schemaReader, invalidSyntaxException), invalidSyntaxException) {
companion object {
private fun buildMessage(
schemaReader: Reader,
invalidSyntaxException: InvalidSyntaxException
): String {
schemaReader.use { reader ->
return """
|Unable to parse the schema...
|${invalidSyntaxException.message}
|
|Schema Section:
|>>>
|${invalidSyntaxException.sourcePreview}
|<<<
|
|Full Schema:
|${reader.readText()}
""".trimMargin()
}
}
}
}