Implemented config feature that allows user to ignore unexpected fields from GraphQL response

Author: mskacelik

extensions/smallrye-graphql-client/deployment/pom.xml

@@ -53,6 +53,11 @@
             <artifactId>quarkus-smallrye-graphql-deployment</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-resteasy-reactive-deployment</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>io.smallrye.stork</groupId>
             <artifactId>stork-service-discovery-static-list</artifactId>

extensions/smallrye-graphql-client/deployment/src/test/java/io/quarkus/smallrye/graphql/client/deployment/GraphQLClientUnexpectedFieldsTest.java

@@ -0,0 +1,67 @@
+package io.quarkus.smallrye.graphql.client.deployment;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import jakarta.inject.Inject;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.Produces;
+
+import org.jboss.shrinkwrap.api.asset.EmptyAsset;
+import org.jboss.shrinkwrap.api.asset.StringAsset;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.test.QuarkusUnitTest;
+import io.smallrye.graphql.client.GraphQLClient;
+import io.smallrye.graphql.client.Response;
+import io.smallrye.graphql.client.dynamic.api.DynamicGraphQLClient;
+
+/**
+ * This test verifies that if <code>quarkus.smallrye-graphql-client.CLIENT_NAME.allow-unexpected-response-fields=true</code>
+ * is set, then the client , instead of throwing an exception, logs a warning if it receives an unexpected top-level
+ * field in a response.
+ */
+public class GraphQLClientUnexpectedFieldsTest {
+
+    static String url = "http://" + System.getProperty("quarkus.http.host", "localhost") + ":"
+            + System.getProperty("quarkus.http.test-port", "8081") + "/invalid-graphql-endpoint";
+
+    @RegisterExtension
+    static QuarkusUnitTest test = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addAsResource(
+                            new StringAsset(
+                                    "quarkus.smallrye-graphql-client.client1.url=" + url + "\n" +
+                                            "quarkus.smallrye-graphql-client.client1.allow-unexpected-response-fields=true\n"),
+                            "application.properties")
+                    .addClass(MockGraphQLEndpoint.class)
+                    .addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml"));
+
+    @Path("/invalid-graphql-endpoint")
+    @Produces("application/json+graphql")
+    @Consumes("application/json")
+    public static class MockGraphQLEndpoint {
+        @POST
+        public String returnInvalidResponse() {
+            return "{\n" +
+                    "  \"data\": {\n" +
+                    "    \"number\": 32\n" +
+                    "  },\n" +
+                    "  \"bugs\": {\n" +
+                    "  }\n" +
+                    "}";
+        }
+    }
+
+    @Inject
+    @GraphQLClient("client1")
+    DynamicGraphQLClient client;
+
+    @Test
+    public void ignoringUnexpectedResponseField() throws Exception {
+        Response response = client.executeSync("query {something}}");
+        assertEquals(32, response.getObject(Long.class, "number"));
+    }
+}

extensions/smallrye-graphql-client/runtime/src/main/java/io/quarkus/smallrye/graphql/client/runtime/GraphQLClientConfig.java

@@ -119,4 +119,12 @@ public class GraphQLClientConfig {
      */
     @ConfigItem(name = "init-payload")
     public Map<String, String> initPayload;
+
+    /**
+     * Allowing unexpected fields in response.
+     * If true, there will be warning log of an unexpected field.
+     * Else it throws an error.
+     */
+    @ConfigItem
+    public Optional<Boolean> allowUnexpectedResponseFields;
 }

extensions/smallrye-graphql-client/runtime/src/main/java/io/quarkus/smallrye/graphql/client/runtime/GraphQLClientConfigurationMergerBean.java

@@ -114,6 +114,7 @@ private GraphQLClientConfiguration toSmallRyeNativeConfiguration(GraphQLClientCo
         quarkusConfig.executeSingleResultOperationsOverWebsocket
                 .ifPresent(transformed::setExecuteSingleOperationsOverWebsocket);
         quarkusConfig.websocketInitializationTimeout.ifPresent(transformed::setWebsocketInitializationTimeout);
+        quarkusConfig.allowUnexpectedResponseFields.ifPresent(transformed::setAllowUnexpectedResponseFields);
         return transformed;
     }