Merge branch 'Hammer_QaulityBacklog_GraphQL_24052022' of github.com:magento-gl/magento2ce into Hammer_QaulityBacklog_GraphQL_24052022

Author: glo71317

app/code/Magento/CatalogGraphQl/Model/Config/AttributeReader.php

@@ -6,46 +6,61 @@
 
 namespace Magento\CatalogGraphQl\Model\Config;
 
+use Magento\Catalog\Model\Product;
+use Magento\Catalog\Model\ResourceModel\Eav\Attribute;
+use Magento\CatalogGraphQl\Model\Resolver\Products\Attributes\Collection;
+use Magento\EavGraphQl\Model\Resolver\Query\Type;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Config\ReaderInterface;
 use Magento\Framework\GraphQl\Exception\GraphQlInputException;
 use Magento\Framework\GraphQl\Schema\Type\Entity\MapperInterface;
 use Magento\Framework\Reflection\TypeProcessor;
-use Magento\EavGraphQl\Model\Resolver\Query\Type;
-use Magento\CatalogGraphQl\Model\Resolver\Products\Attributes\Collection;
+use Magento\Store\Model\ScopeInterface;
 
 /**
  * Adds custom/eav attribute to Catalog product types in the GraphQL config.
  */
 class AttributeReader implements ReaderInterface
 {
+    public const XML_PATH_INCLUDE_DYNAMIC_ATTRIBUTES =
+        'web_api/graphql/include_dynamic_attributes_as_entity_type_fields';
+
     /**
      * @var MapperInterface
      */
-    private $mapper;
+    private MapperInterface $mapper;
 
     /**
      * @var Type
      */
-    private $typeLocator;
+    private Type $typeLocator;
 
     /**
      * @var Collection
      */
-    private $collection;
+    private Collection $collection;
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private ScopeConfigInterface $config;
 
     /**
      * @param MapperInterface $mapper
      * @param Type $typeLocator
      * @param Collection $collection
+     * @param ScopeConfigInterface $config
      */
     public function __construct(
         MapperInterface $mapper,
         Type $typeLocator,
-        Collection $collection
+        Collection $collection,
+        ScopeConfigInterface $config
     ) {
         $this->mapper = $mapper;
         $this->typeLocator = $typeLocator;
         $this->collection = $collection;
+        $this->config = $config;
     }
 
     /**
@@ -58,22 +73,25 @@ public function __construct(
      */
     public function read($scope = null) : array
     {
-        $typeNames = $this->mapper->getMappedTypes(\Magento\Catalog\Model\Product::ENTITY);
-        $config =[];
-        /** @var \Magento\Catalog\Model\ResourceModel\Eav\Attribute $attribute */
-        foreach ($this->collection->getAttributes() as $attribute) {
-            $attributeCode = $attribute->getAttributeCode();
-            $locatedType = $this->typeLocator->getType(
-                $attributeCode,
-                \Magento\Catalog\Model\Product::ENTITY
-            ) ?: 'String';
-            $locatedType = $locatedType === TypeProcessor::NORMALIZED_ANY_TYPE ? 'String' : ucfirst($locatedType);
-            foreach ($typeNames as $typeName) {
-                $config[$typeName]['fields'][$attributeCode] = [
-                    'name' => $attributeCode,
-                    'type' => $locatedType,
-                    'arguments' => []
-                ];
+        $config = [];
+
+        if ($this->config->isSetFlag(self::XML_PATH_INCLUDE_DYNAMIC_ATTRIBUTES, ScopeInterface::SCOPE_STORE)) {
+            $typeNames = $this->mapper->getMappedTypes(Product::ENTITY);
+
+            /** @var Attribute $attribute */
+            foreach ($this->collection->getAttributes() as $attribute) {
+                $attributeCode = $attribute->getAttributeCode();
+                $locatedType = $this->typeLocator->getType($attributeCode, Product::ENTITY) ?: 'String';
+                $locatedType = TypeProcessor::NORMALIZED_ANY_TYPE === $locatedType ? 'String' : ucfirst($locatedType);
+
+                foreach ($typeNames as $typeName) {
+                    $config[$typeName]['fields'][$attributeCode] = [
+                        'name' => $attributeCode,
+                        'type' => $locatedType,
+                        'arguments' => [],
+                        'deprecated' => ['reason' => 'Use the `custom_attributes` field instead.'],
+                    ];
+                }
             }
         }
 

app/code/Magento/GraphQl/etc/adminhtml/system.xml

@@ -35,6 +35,16 @@
                 </field>
             </group>
         </section>
+        <section id="web_api">
+            <group id="graphql" translate="label" type="text" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
+                <label>GraphQl</label>
+                <field id="include_dynamic_attributes_as_entity_type_fields" translate="label" type="select" sortOrder="25" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Include dynamic attributes as entity type fields</label>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                    <config_path>web_api/graphql/include_dynamic_attributes_as_entity_type_fields</config_path>
+                </field>
+            </group>
+        </section>
     </system>
 </config>
 

app/code/Magento/GraphQl/etc/config.xml

@@ -5,8 +5,14 @@
  * See COPYING.txt for license details.
  */
 -->
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
     <default>
+        <web_api>
+            <graphql>
+                <include_dynamic_attributes_as_entity_type_fields>1</include_dynamic_attributes_as_entity_type_fields>
+            </graphql>
+        </web_api>
         <graphql>
             <session>
                 <disable>0</disable>

dev/tests/integration/testsuite/Magento/CatalogGraphQl/Model/Config/AttributeReaderTest.php

@@ -0,0 +1,65 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\CatalogGraphQl\Model\Config;
+
+use Magento\Framework\GraphQl\Schema\Type\Entity\MapperInterface;
+use Magento\TestFramework\Helper\Bootstrap;
+use PHPUnit\Framework\TestCase;
+
+class AttributeReaderTest extends TestCase
+{
+    /** @var AttributeReader  */
+    private $attributeReader;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp(): void
+    {
+        $objectManager = Bootstrap::getObjectManager();
+        $mapper = $this->createMock(MapperInterface::class);
+        $mapper->expects($this->any())
+            ->method('getMappedTypes')
+            ->willReturn([
+                'product' => 'ProductInterface',
+                'simple' => 'SimpleProduct',
+                'virtual' => 'VirtualProduct',
+                'downloadable' => 'DownloadableProduct',
+                'bundle' => 'BundleProduct',
+                'grouped' => 'GroupedProduct',
+                'configurable' => 'ConfigurableProduct',
+            ]);
+        $this->attributeReader = $objectManager->create(AttributeReader::class, ['mapper' => $mapper]);
+    }
+
+    /**
+     * @magentoConfigFixture current_store web_api/graphql/include_dynamic_attributes_as_entity_type_fields 1
+     */
+    public function testReadWithIncludeDynamicAttributesOptionEnabled()
+    {
+        $result = $this->attributeReader->read();
+        $this->assertCount(7, $result);
+
+        //Adding custom attribute dynamically to the schema is deprecated.
+        foreach ($result as $typeName) {
+            if (!isset($typeName['fields'])) {
+                $this->fail('Invalid config');
+            }
+
+            array_map(fn ($attribute) => $this->assertArrayHasKey('deprecated', $attribute), $typeName['fields']);
+        }
+    }
+
+    /**
+     * @magentoConfigFixture current_store web_api/graphql/include_dynamic_attributes_as_entity_type_fields 0
+     */
+    public function testReadWithIncludeDynamicAttributesOptionDisabled()
+    {
+        $this->assertEmpty($this->attributeReader->read());
+    }
+}