GraphQl-93: Implement support for variables in query

naydav · naydav · commit 2e74cc1fc695 · 2019-01-22T17:22:26.000-06:00
-- Builds fixes
diff --git a/dev/tests/api-functional/testsuite/Magento/GraphQl/VariablesSupportQueryTest.php b/dev/tests/api-functional/testsuite/Magento/GraphQl/VariablesSupportQueryTest.php
@@ -7,9 +7,8 @@
 
 namespace Magento\GraphQl;
 
-use Magento\Catalog\Api\Data\ProductInterface;
+use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\TestCase\GraphQlAbstract;
-use Magento\TestFramework\ObjectManager;
 use Magento\Catalog\Api\ProductRepositoryInterface;
 
 class VariablesSupportQueryTest extends GraphQlAbstract
@@ -21,7 +20,7 @@ class VariablesSupportQueryTest extends GraphQlAbstract
 
     protected function setUp()
     {
-        $this->productRepository = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(ProductRepositoryInterface::class);
+        $this->productRepository = Bootstrap::getObjectManager()->get(ProductRepositoryInterface::class);
     }
 
     /**
diff --git a/lib/internal/Magento/Framework/GraphQl/Config.php b/lib/internal/Magento/Framework/GraphQl/Config.php
@@ -62,7 +62,7 @@ public function getConfigElement(string $configElementName) : ConfigElementInter
         $fieldsInQuery = $this->queryFields->getFieldsUsedInQuery();
         if (isset($data['fields'])) {
             if (!empty($fieldsInQuery)) {
-                foreach ($data['fields'] as $fieldName => $fieldConfig) {
+                foreach (array_keys($data['fields']) as $fieldName) {
                     if (!isset($fieldsInQuery[$fieldName])) {
                         unset($data['fields'][$fieldName]);
                     }
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/Element/FieldsFactory.php b/lib/internal/Magento/Framework/GraphQl/Config/Element/FieldsFactory.php
@@ -0,0 +1,62 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework\GraphQl\Config\Element;
+
+/**
+ * Fields object factory
+ */
+class FieldsFactory
+{
+    /**
+     * @var ArgumentFactory
+     */
+    private $argumentFactory;
+
+    /**
+     * @var FieldFactory
+     */
+    private $fieldFactory;
+
+    /**
+     * @param ArgumentFactory $argumentFactory
+     * @param FieldFactory $fieldFactory
+     */
+    public function __construct(
+        ArgumentFactory $argumentFactory,
+        FieldFactory $fieldFactory
+    ) {
+        $this->argumentFactory = $argumentFactory;
+        $this->fieldFactory = $fieldFactory;
+    }
+
+    /**
+     * Create a fields object from a configured array with optional arguments.
+     *
+     * Field data must contain name and type. Other values are optional and include required, itemType, description,
+     * and resolver. Arguments array must be in the format of [$argumentData['name'] => $argumentData].
+     *
+     * @param array $fieldsData
+     * @return Field[]
+     */
+    public function createFromConfigData(
+        array $fieldsData
+    ) : array {
+        $fields = [];
+        foreach ($fieldsData as $fieldData) {
+            $arguments = [];
+            foreach ($fieldData['arguments'] as $argumentData) {
+                $arguments[$argumentData['name']] = $this->argumentFactory->createFromConfigData($argumentData);
+            }
+            $fields[$fieldData['name']] = $this->fieldFactory->createFromConfigData(
+                $fieldData,
+                $arguments
+            );
+        }
+        return $fields;
+    }
+}
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/Element/InputFactory.php b/lib/internal/Magento/Framework/GraphQl/Config/Element/InputFactory.php
@@ -22,28 +22,20 @@ class InputFactory implements ConfigElementFactoryInterface
     private $objectManager;
 
     /**
-     * @var ArgumentFactory
+     * @var FieldsFactory
      */
-    private $argumentFactory;
-
-    /**
-     * @var FieldFactory
-     */
-    private $fieldFactory;
+    private $fieldsFactory;
 
     /**
      * @param ObjectManagerInterface $objectManager
-     * @param ArgumentFactory $argumentFactory
-     * @param FieldFactory $fieldFactory
+     * @param FieldsFactory $fieldsFactory
      */
     public function __construct(
         ObjectManagerInterface $objectManager,
-        ArgumentFactory $argumentFactory,
-        FieldFactory $fieldFactory
+        FieldsFactory $fieldsFactory
     ) {
         $this->objectManager = $objectManager;
-        $this->argumentFactory = $argumentFactory;
-        $this->fieldFactory = $fieldFactory;
+        $this->fieldsFactory = $fieldsFactory;
     }
 
     /**
@@ -54,18 +46,8 @@ public function __construct(
      */
     public function createFromConfigData(array $data): ConfigElementInterface
     {
-        $fields = [];
-        $data['fields'] = isset($data['fields']) ? $data['fields'] : [];
-        foreach ($data['fields'] as $field) {
-            $arguments = [];
-            foreach ($field['arguments'] as $argument) {
-                $arguments[$argument['name']] = $this->argumentFactory->createFromConfigData($argument);
-            }
-            $fields[$field['name']] = $this->fieldFactory->createFromConfigData(
-                $field,
-                $arguments
-            );
-        }
+        $fields = isset($data['fields']) ? $this->fieldsFactory->createFromConfigData($data['fields']) : [];
+
         return $this->create(
             $data,
             $fields
diff --git a/lib/internal/Magento/Framework/GraphQl/Config/Element/TypeFactory.php b/lib/internal/Magento/Framework/GraphQl/Config/Element/TypeFactory.php
@@ -22,28 +22,20 @@ class TypeFactory implements ConfigElementFactoryInterface
     private $objectManager;
 
     /**
-     * @var ArgumentFactory
+     * @var FieldsFactory
      */
-    private $argumentFactory;
-
-    /**
-     * @var FieldFactory
-     */
-    private $fieldFactory;
+    private $fieldsFactory;
 
     /**
      * @param ObjectManagerInterface $objectManager
-     * @param ArgumentFactory $argumentFactory
-     * @param FieldFactory $fieldFactory
+     * @param FieldsFactory $fieldsFactory
      */
     public function __construct(
         ObjectManagerInterface $objectManager,
-        ArgumentFactory $argumentFactory,
-        FieldFactory $fieldFactory
+        FieldsFactory $fieldsFactory
     ) {
         $this->objectManager = $objectManager;
-        $this->argumentFactory = $argumentFactory;
-        $this->fieldFactory = $fieldFactory;
+        $this->fieldsFactory = $fieldsFactory;
     }
 
     /**
@@ -54,18 +46,8 @@ public function __construct(
      */
     public function createFromConfigData(array $data): ConfigElementInterface
     {
-        $fields = [];
-        $data['fields'] = isset($data['fields']) ? $data['fields'] : [];
-        foreach ($data['fields'] as $field) {
-            $arguments = [];
-            foreach ($field['arguments'] as $argument) {
-                $arguments[$argument['name']] = $this->argumentFactory->createFromConfigData($argument);
-            }
-            $fields[$field['name']] = $this->fieldFactory->createFromConfigData(
-                $field,
-                $arguments
-            );
-        }
+        $fields = isset($data['fields']) ? $this->fieldsFactory->createFromConfigData($data['fields']) : [];
+
         return $this->create(
             $data,
             $fields
diff --git a/lib/internal/Magento/Framework/GraphQl/Query/Fields.php b/lib/internal/Magento/Framework/GraphQl/Query/Fields.php
@@ -44,7 +44,7 @@ public function setQuery($query, array $variables = null)
                 ]
             );
             if (isset($variables)) {
-                $queryFields = array_merge($queryFields, $this->extracttVariables($variables));
+                $queryFields = array_merge($queryFields, $this->extractVariables($variables));
             }
         } catch (\Exception $e) {
             // If a syntax error is encountered do not collect fields
@@ -75,12 +75,12 @@ public function getFieldsUsedInQuery()
      *
      * @return string[]
      */
-    private function extracttVariables(array $variables): array
+    private function extractVariables(array $variables): array
     {
         $fields = [];
-        foreach ($variables as $key => $value){
+        foreach ($variables as $key => $value) {
             if (is_array($value)){
-                $fields = array_merge($fields, $this->extracttVariables($value));
+                $fields = array_merge($fields, $this->extractVariables($value));
             }
             $fields[$key] = $key;
         }
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/SchemaGenerator.php b/lib/internal/Magento/Framework/GraphQl/Schema/SchemaGenerator.php
@@ -48,7 +48,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public function generate() : Schema
     {
@@ -61,7 +61,7 @@ public function generate() : Schema
                 },
                 'types' => function () {
                     $typesImplementors = [];
-                    foreach ($this->config->getDeclaredTypeNames() as $type) {
+                    foreach ($this->config->getDeclaredTypes() as $type) {
                         $typesImplementors [] = $this->typeRegistry->get($type['name']);
                     }
                     return $typesImplementors;
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/Input/InputMapper.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/Input/InputMapper.php
@@ -13,6 +13,9 @@
 use Magento\Framework\GraphQl\Schema\Type\ScalarTypes;
 use Magento\Framework\GraphQl\Schema\Type\TypeRegistry;
 
+/**
+ * Prepare argument's metadata for GraphQL schema generation
+ */
 class InputMapper
 {
     /**
diff --git a/lib/internal/Magento/Framework/GraphQl/Schema/Type/Output/ElementMapper/Formatter/Fields.php b/lib/internal/Magento/Framework/GraphQl/Schema/Type/Output/ElementMapper/Formatter/Fields.php
@@ -79,7 +79,7 @@ public function __construct(
     }
 
     /**
-     * {@inheritDoc}
+     * @inheritdoc
      */
     public function format(TypeInterface $configElement, OutputTypeInterface $outputType): array
     {

Original file line number	Diff line number	Diff line change
`@@ -7,9 +7,8 @@`
`7`	`7`
`8`	`8`	`namespace Magento\GraphQl;`
`9`	`9`
`10`		`-use Magento\Catalog\Api\Data\ProductInterface;`
	`10`	`+use Magento\TestFramework\Helper\Bootstrap;`
`11`	`11`	`use Magento\TestFramework\TestCase\GraphQlAbstract;`
`12`		`-use Magento\TestFramework\ObjectManager;`
`13`	`12`	`use Magento\Catalog\Api\ProductRepositoryInterface;`
`14`	`13`
`15`	`14`	`class VariablesSupportQueryTest extends GraphQlAbstract`
`@@ -21,7 +20,7 @@ class VariablesSupportQueryTest extends GraphQlAbstract`
`21`	`20`
`22`	`21`	`protected function setUp()`
`23`	`22`	`{`
`24`		`- $this->productRepository = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(ProductRepositoryInterface::class);`
	`23`	`+ $this->productRepository = Bootstrap::getObjectManager()->get(ProductRepositoryInterface::class);`
`25`	`24`	`}`
`26`	`25`
`27`	`26`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ public function getConfigElement(string $configElementName) : ConfigElementInter`
`62`	`62`	`$fieldsInQuery = $this->queryFields->getFieldsUsedInQuery();`
`63`	`63`	`if (isset($data['fields'])) {`
`64`	`64`	`if (!empty($fieldsInQuery)) {`
`65`		`- foreach ($data['fields'] as $fieldName => $fieldConfig) {`
	`65`	`+ foreach (array_keys($data['fields']) as $fieldName) {`
`66`	`66`	`if (!isset($fieldsInQuery[$fieldName])) {`
`67`	`67`	`unset($data['fields'][$fieldName]);`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ public function setQuery($query, array $variables = null)`
`44`	`44`	`]`
`45`	`45`	`);`
`46`	`46`	`if (isset($variables)) {`
`47`		`- $queryFields = array_merge($queryFields, $this->extracttVariables($variables));`
	`47`	`+ $queryFields = array_merge($queryFields, $this->extractVariables($variables));`
`48`	`48`	`}`
`49`	`49`	`} catch (\Exception $e) {`
`50`	`50`	`// If a syntax error is encountered do not collect fields`
`@@ -75,12 +75,12 @@ public function getFieldsUsedInQuery()`
`75`	`75`	`*`
`76`	`76`	`* @return string[]`
`77`	`77`	`*/`
`78`		`- private function extracttVariables(array $variables): array`
	`78`	`+ private function extractVariables(array $variables): array`
`79`	`79`	`{`
`80`	`80`	`$fields = [];`
`81`		`- foreach ($variables as $key => $value){`
	`81`	`+ foreach ($variables as $key => $value) {`
`82`	`82`	`if (is_array($value)){`
`83`		`- $fields = array_merge($fields, $this->extracttVariables($value));`
	`83`	`+ $fields = array_merge($fields, $this->extractVariables($value));`
`84`	`84`	`}`
`85`	`85`	`$fields[$key] = $key;`
`86`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public function __construct(`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`/**`
`51`		`- * {@inheritdoc}`
	`51`	`+ * @inheritdoc`
`52`	`52`	`*/`
`53`	`53`	`public function generate() : Schema`
`54`	`54`	`{`
`@@ -61,7 +61,7 @@ public function generate() : Schema`
`61`	`61`	`},`
`62`	`62`	`'types' => function () {`
`63`	`63`	`$typesImplementors = [];`
`64`		`- foreach ($this->config->getDeclaredTypeNames() as $type) {`
	`64`	`+ foreach ($this->config->getDeclaredTypes() as $type) {`
`65`	`65`	`$typesImplementors [] = $this->typeRegistry->get($type['name']);`
`66`	`66`	`}`
`67`	`67`	`return $typesImplementors;`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,9 @@`
`13`	`13`	`use Magento\Framework\GraphQl\Schema\Type\ScalarTypes;`
`14`	`14`	`use Magento\Framework\GraphQl\Schema\Type\TypeRegistry;`
`15`	`15`
	`16`	`+/**`
	`17`	`+ * Prepare argument's metadata for GraphQL schema generation`
	`18`	`+ */`
`16`	`19`	`class InputMapper`
`17`	`20`	`{`
`18`	`21`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public function __construct(`
`79`	`79`	`}`
`80`	`80`
`81`	`81`	`/**`
`82`		`- * {@inheritDoc}`
	`82`	`+ * @inheritdoc`
`83`	`83`	`*/`
`84`	`84`	`public function format(TypeInterface $configElement, OutputTypeInterface $outputType): array`
`85`	`85`	`{`