Merge pull request #111 from Netflix/codegen-improvements

Fix generation of getters in interfaces to return interface types when using generateInterfaces
Netflix · Apr 22, 2021 · bb6da39 · bb6da39
2 parents 94e55d7 + 5e6aae5
commit bb6da39
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 3 deletions.
diff --git a/...ore/src/main/kotlin/com/netflix/graphql/dgs/codegen/generators/java/InterfaceGenerator.kt b/...ore/src/main/kotlin/com/netflix/graphql/dgs/codegen/generators/java/InterfaceGenerator.kt
@@ -31,6 +31,7 @@ class InterfaceGenerator(config: CodeGenConfig, private val document: Document)
 
     private val packageName = config.packageNameTypes
     private val typeUtils = TypeUtils(packageName, config, document)
+    private val useInterfaceType = config.generateInterfaces
 
     fun generate(definition: InterfaceTypeDefinition): CodeGenResult {
         val javaType = TypeSpec.interfaceBuilder(definition.name)
@@ -81,7 +82,7 @@ class InterfaceGenerator(config: CodeGenConfig, private val document: Document)
 
     private fun addInterfaceMethod(fieldDefinition: FieldDefinition, javaType: TypeSpec.Builder) {
 
-        val returnType = typeUtils.findReturnType(fieldDefinition.type)
+        val returnType = typeUtils.findReturnType(fieldDefinition.type, useInterfaceType)
 
         val fieldName = fieldDefinition.name
         javaType.addMethod(

diff --git a/graphql-dgs-codegen-core/src/test/kotlin/com/netflix/graphql/dgs/codegen/CodeGenTest.kt b/graphql-dgs-codegen-core/src/test/kotlin/com/netflix/graphql/dgs/codegen/CodeGenTest.kt
@@ -22,7 +22,10 @@ import com.google.common.jimfs.Configuration
 import com.google.common.jimfs.Jimfs
 import com.google.common.truth.Truth
 import com.netflix.graphql.dgs.codegen.generators.java.disableJsonTypeInfoAnnotation
-import com.squareup.javapoet.*
+import com.squareup.javapoet.ClassName
+import com.squareup.javapoet.JavaFile
+import com.squareup.javapoet.ParameterizedTypeName
+import com.squareup.javapoet.WildcardTypeName
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.params.ParameterizedTest
@@ -489,7 +492,7 @@ class CodeGenTest {
         val (dataTypes, interfaces) = CodeGen(
             CodeGenConfig(
                 schemas = setOf(schema),
-                packageName = basePackageName,
+                packageName = basePackageName
             )
         ).generate() as CodeGenResult
 
@@ -1871,6 +1874,55 @@ class CodeGenTest {
             .isEqualTo("""{mandatoryString:"a",mandatoryInt:1,mandatoryList:["x"]}""")
     }
 
+    @Test
+    fun generateObjectTypeInterfaceWithInterface() {
+        val schema = """
+        type Team {
+            name: String
+        }
+
+        type Player {
+            name: String
+        }
+
+        interface Standing {
+            position: Int!
+            team: Team!
+        }
+        """.trimIndent()
+
+        val result = CodeGen(
+            CodeGenConfig(
+                schemas = setOf(schema),
+                packageName = basePackageName,
+                generateInterfaces = true
+            )
+        ).generate() as CodeGenResult
+
+        val interfaces = result.interfaces
+        val dataTypes = result.dataTypes
+
+        assertThat(interfaces).hasSize(3)
+
+        val team = interfaces[0]
+        assertThat(team.typeSpec.name).isEqualTo("ITeam")
+        assertThat(team.typeSpec.methodSpecs).extracting("name").containsExactly("getName")
+        assertThat(team.typeSpec.methodSpecs[0].returnType).extracting("simpleName").containsExactly("String")
+
+        val player = interfaces[1]
+        assertThat(player.typeSpec.name).isEqualTo("IPlayer")
+        assertThat(player.typeSpec.methodSpecs).extracting("name").containsExactly("getName")
+        assertThat(player.typeSpec.methodSpecs[0].returnType).extracting("simpleName").containsExactly("String")
+
+        val standing = interfaces[2]
+        assertThat(standing.typeSpec.name).isEqualTo("Standing")
+        assertThat(standing.typeSpec.methodSpecs).extracting("name").containsExactly("getPosition", "getTeam")
+        assertThat(standing.typeSpec.methodSpecs[0].returnType.toString()).contains("int")
+        assertThat(standing.typeSpec.methodSpecs[1].returnType).extracting("simpleName").containsExactly("ITeam")
+
+        assertCompilesJava(dataTypes.plus(interfaces))
+    }
+
     @Test
     fun generateObjectTypeInterface() {
         val schema = """