MC-22838: Required input type values validation does not work correctly

Author: danielrenaud

dev/tests/api-functional/testsuite/Magento/GraphQl/Framework/RequiredInputArgumentTest.php

@@ -0,0 +1,77 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\GraphQl\Framework;
+
+use Magento\TestFramework\TestCase\GraphQlAbstract;
+use Magento\TestFramework\TestCase\GraphQl\ResponseContainsErrorsException;
+
+/**
+ * Test that required input parameters are properly validated on framework level
+ */
+class RequiredInputArgumentTest extends GraphQlAbstract
+{
+
+    /**
+     * Test that a simple input value will be treated as required
+     *
+     * We should see error message from framework not the Resolver
+     * urlResolver query has required input arg "url"
+     */
+    public function testSimpleInputArgumentRequired()
+    {
+        $query = <<<QUERY
+    {
+        urlResolver{
+            id
+            type
+        }
+    }
+QUERY;
+
+        $expectedExceptionsMessage = 'GraphQL response contains errors:'
+            . ' Field "urlResolver" argument "url" of type "String!" is required but not provided.';
+        $this->expectException(ResponseContainsErrorsException::class);
+        $this->expectExceptionMessage($expectedExceptionsMessage);
+
+        $this->graphQlQuery($query);
+    }
+
+    /**
+     * Test that a more complex required argument is handled properly
+     *
+     * updateCartItems mutation has required parameter input.cart_items.cart_item_id
+     */
+    public function testInputObjectArgumentRequired()
+    {
+        $query = <<<QUERY
+    mutation {
+        updateCartItems(
+            input: {
+                cart_id: "foobar"
+                cart_items: [
+                    {
+                        quantity: 2
+                    }
+                ]
+            }
+        ) {
+            cart {
+                total_quantity
+            }
+        }
+    }
+QUERY;
+
+        $expectedExceptionsMessage = 'GraphQL response contains errors:'
+            . ' Field CartItemUpdateInput.cart_item_id of required type Int! was not provided.';
+        $this->expectException(ResponseContainsErrorsException::class);
+        $this->expectExceptionMessage($expectedExceptionsMessage);
+
+        $this->graphQlMutation($query);
+    }
+}

lib/internal/Magento/Framework/GraphQl/Config.php

@@ -62,13 +62,9 @@ public function getConfigElement(string $configElementName) : ConfigElementInter
         $fieldsInQuery = $this->queryFields->getFieldsUsedInQuery();
         if (isset($data['fields'])) {
             if (!empty($fieldsInQuery)) {
-                foreach (array_keys($data['fields']) as $fieldName) {
-                    if (!isset($fieldsInQuery[$fieldName])) {
-                        unset($data['fields'][$fieldName]);
-                    }
-                }
+                $data['fieldsInQuery'] = array_intersect_key($data['fields'], $fieldsInQuery);
+                ksort($data['fieldsInQuery']);
             }
-
             ksort($data['fields']);
         }
 

lib/internal/Magento/Framework/GraphQl/Config/Element/InterfaceFactory.php

@@ -47,11 +47,15 @@ public function __construct(
 
     /**
      * Instantiate an object representing 'interface' GraphQL config element.
+     *
+     * @param array $data
+     * @return ConfigElementInterface
      */
     public function createFromConfigData(array $data): ConfigElementInterface
     {
+        $fieldsData = $data['fieldsInQuery'] ?? ($data['fields'] ?? []);
         $fields = [];
-        foreach ($data['fields'] as $field) {
+        foreach ($fieldsData as $field) {
             $arguments = [];
             foreach ($field['arguments'] as $argument) {
                 $arguments[$argument['name']] = $this->argumentFactory->createFromConfigData($argument);

lib/internal/Magento/Framework/GraphQl/Config/Element/TypeFactory.php

@@ -46,7 +46,8 @@ public function __construct(
      */
     public function createFromConfigData(array $data): ConfigElementInterface
     {
-        $fields = isset($data['fields']) ? $this->fieldsFactory->createFromConfigData($data['fields']) : [];
+        $fieldsData = $data['fieldsInQuery'] ?? ($data['fields'] ?? []);
+        $fields = $this->fieldsFactory->createFromConfigData($fieldsData);
 
         return $this->create(
             $data,