Skip to content

feat: extend shared types mechanism to include response types #1

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: extend shared types mechanism to include response types #1

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
44 changes: 44 additions & 0 deletions ...rc/main/kotlin/com/expediagroup/graphql/plugin/client/generator/GraphQLClientGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ class GraphQLClientGenerator(
private val documentParser: Parser = Parser()
private val typeAliases: MutableMap<String, TypeAliasSpec> = mutableMapOf()
private val sharedTypes: MutableMap<ClassName, List<TypeSpec>> = mutableMapOf()
private val responseTypeSignatures: MutableMap<String, MutableList<Pair<ClassName, TypeSpec>>> = mutableMapOf()
private var generateOptionalSerializer: Boolean = false
private val graphQLSchema: TypeDefinitionRegistry
private val parserOptions: ParserOptions = ParserOptions.newParserOptions().also { this.config.parserOptions(it) }.build()
Expand All @@ -70,6 +71,8 @@ class GraphQLClientGenerator(
result.addAll(generate(query))
}

// Process collected response types for sharing
processSharedResponseTypes()
// common shared types
for ((className, typeSpecs) in sharedTypes) {
val fileSpec = FileSpec.builder(className.packageName, className.simpleName)
Expand Down Expand Up @@ -216,6 +219,9 @@ class GraphQLClientGenerator(
// shared types
sharedTypes.putAll(context.enumClassToTypeSpecs.mapValues { listOf(it.value) })
sharedTypes.putAll(context.inputClassToTypeSpecs.mapValues { listOf(it.value) })

// Collect response types for potential sharing
collectResponseTypesForSharing(context)
context.scalarClassToConverterTypeSpecs
.values
.forEach {
Expand All @@ -240,6 +246,44 @@ class GraphQLClientGenerator(
return fileSpecs
}

private fun collectResponseTypesForSharing(context: GraphQLClientGeneratorContext) {
// Collect all response types with their structural signatures
context.typeSpecs.forEach { (className, typeSpec) ->
if (className.packageName.contains(context.operationName.lowercase()) &&
!className.packageName.contains(".inputs") &&
!className.packageName.contains(".enums")
) {

val signature = generateResponseTypeStructuralSignature(typeSpec)
responseTypeSignatures.getOrPut(signature) { mutableListOf() }.add(className to typeSpec)
}
}
}

private fun generateResponseTypeStructuralSignature(typeSpec: TypeSpec): String {
// Generate signature based on property names and types
val properties = typeSpec.propertySpecs.map { prop ->
"${prop.name}:${prop.type}"
}.sorted()
return "${typeSpec.name}:${properties.joinToString(",")}"
}

private fun processSharedResponseTypes() {
// Find response types that appear multiple times with the same signature
responseTypeSignatures.forEach { (signature, typeList) ->
if (typeList.size > 1) {
// This response type is shared across multiple operations
val (firstClassName, firstTypeSpec) = typeList.first()
val sharedClassName = ClassName("${config.packageName}.responses", firstTypeSpec.name!!)

// Create a new TypeSpec for the shared package
val sharedTypeSpec = firstTypeSpec.toBuilder()
.build()
sharedTypes[sharedClassName] = listOf(sharedTypeSpec)
}
}
}

private fun findRootType(operationDefinition: OperationDefinition): ObjectTypeDefinition {
val operationNames = if (graphQLSchema.schemaDefinition().isPresent) {
graphQLSchema.schemaDefinition().get().operationTypeDefinitions.associateBy({ it.name.uppercase() }, { it.typeName.name })
Expand Down