Merge pull request #497 from jdmcmahan/client-query-name

Initialize `GraphQLQuery#name` from generated subclasses
Netflix · Dec 6, 2022 · 0cb9071 · 0cb9071
2 parents 9dfa263 + 8f221e6
commit 0cb9071
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 5 deletions.
diff --git a/...ore/src/main/kotlin/com/netflix/graphql/dgs/codegen/generators/java/ClientApiGenerator.kt b/...ore/src/main/kotlin/com/netflix/graphql/dgs/codegen/generators/java/ClientApiGenerator.kt
@@ -110,12 +110,12 @@ class ClientApiGenerator(private val config: CodeGenConfig, private val document
                     .addCode(
                         if (it.inputValueDefinitions.isNotEmpty()) {
                             """
-                            |return new $methodName(${it.inputValueDefinitions.joinToString(", ") { ReservedKeywordSanitizer.sanitize(it.name) }}, fieldsSet);
+                            |return new $methodName(${it.inputValueDefinitions.joinToString(", ") { ReservedKeywordSanitizer.sanitize(it.name) }}, queryName, fieldsSet);
                             |         
                             """.trimMargin()
                         } else {
                             """
-                            |return new $methodName();                                     
+                            |return new $methodName(queryName);                                     
                             """.trimMargin()
                         }
                     )
@@ -126,7 +126,7 @@ class ClientApiGenerator(private val config: CodeGenConfig, private val document
             .addModifiers(Modifier.PUBLIC)
         constructorBuilder.addCode(
             """
-            |super("${operation.lowercase()}");
+            |super("${operation.lowercase()}", queryName);
             |
             """.trimMargin()
         )
@@ -170,6 +170,22 @@ class ClientApiGenerator(private val config: CodeGenConfig, private val document
             }
         }
 
+        val nameMethodBuilder = MethodSpec.methodBuilder("queryName")
+            .addParameter(String::class.java, "queryName")
+            .returns(ClassName.get("", "Builder"))
+            .addModifiers(Modifier.PUBLIC)
+            .addCode(
+                """
+                |this.queryName = queryName;
+                |return this;
+                """.trimMargin()
+            )
+
+        builderClass.addField(FieldSpec.builder(String::class.java, "queryName", Modifier.PRIVATE).build())
+            .addMethod(nameMethodBuilder.build())
+
+        constructorBuilder.addParameter(String::class.java, "queryName")
+
         if (it.inputValueDefinitions.size > 0) {
             constructorBuilder.addParameter(setOfStringType, "fieldsSet")
         }

diff --git a/...core/src/test/kotlin/com/netflix/graphql/dgs/codegen/clientapi/ClientApiGenBuilderTest.kt b/...core/src/test/kotlin/com/netflix/graphql/dgs/codegen/clientapi/ClientApiGenBuilderTest.kt
@@ -82,4 +82,60 @@ class ClientApiGenBuilderTest {
         assertThat(result2QueryObject.input.keys).isEmpty()
         assertThat(result2QueryObject.input["nameFilter"]).isNull()
     }
+
+    @Test
+    fun `Query name should be null if not set`() {
+        val schema = """
+            type Query {
+                filter(nameFilter: String): [String]
+            }
+        """.trimIndent()
+
+        val codeGenResult = CodeGen(
+            CodeGenConfig(
+                schemas = setOf(schema),
+                packageName = basePackageName,
+                generateClientApi = true,
+                maxProjectionDepth = 2
+            )
+        ).generate()
+
+        val builderClass = assertCompilesJava(codeGenResult).toClassLoader()
+            .loadClass("$basePackageName.client.FilterGraphQLQuery\$Builder")
+        val buildMethod = builderClass.getMethod("build")
+
+        val builder = builderClass.constructors[0].newInstance()
+        val result2QueryObject: GraphQLQuery = buildMethod.invoke(builder) as GraphQLQuery
+        assertThat(result2QueryObject.name).isNull()
+    }
+
+    @Test
+    fun `Query name should be accessible via GraphQLQuery#name if set`() {
+        val schema = """
+            type Query {
+                filter(nameFilter: String): [String]
+            }
+        """.trimIndent()
+
+        val codeGenResult = CodeGen(
+            CodeGenConfig(
+                schemas = setOf(schema),
+                packageName = basePackageName,
+                generateClientApi = true,
+                maxProjectionDepth = 2
+            )
+        ).generate()
+
+        val builderClass = assertCompilesJava(codeGenResult).toClassLoader()
+            .loadClass("$basePackageName.client.FilterGraphQLQuery\$Builder")
+        val nameMethod = builderClass.getMethod("queryName", String::class.java)
+        val buildMethod = builderClass.getMethod("build")
+
+        val builder = builderClass.constructors[0].newInstance()
+        nameMethod.invoke(builder, "test")
+
+        val result2QueryObject: GraphQLQuery = buildMethod.invoke(builder) as GraphQLQuery
+        assertThat(result2QueryObject.name).isNotNull
+        assertThat(result2QueryObject.name).isEqualTo("test")
+    }
 }
diff --git a/...ore/src/test/kotlin/com/netflix/graphql/dgs/codegen/clientapi/ClientApiGenMutationTest.kt b/...ore/src/test/kotlin/com/netflix/graphql/dgs/codegen/clientapi/ClientApiGenMutationTest.kt
@@ -160,7 +160,7 @@ class ClientApiGenMutationTest {
             .find { it.name == "<init>" }?.code.toString()
 
         val expected = """
-            |super("mutation");
+            |super("mutation", queryName);
             |if (movie != null || fieldsSet.contains("movie")) {
             |    getInput().put("movie", movie);
             |}if (reviews != null || fieldsSet.contains("reviews")) {
@@ -200,7 +200,7 @@ class ClientApiGenMutationTest {
         assert(
             codeGenResult.javaQueryTypes[0].typeSpec.methodSpecs
                 .find { it.name == "<init>" }?.code.toString()
-                .contains("super(\"mutation\");\ngetInput().put(\"movieId\", movieId);")
+                .contains("super(\"mutation\", queryName);\ngetInput().put(\"movieId\", movieId);")
         )
 
         assertCompilesJava(